docs: add upage usage instructions document

This commit is contained in:
LIlGG
2025-09-28 15:26:44 +08:00
parent f4d6e383ce
commit e6747664c2
17 changed files with 720 additions and 412 deletions

View File

@@ -0,0 +1,91 @@
---
id: ways-to-contribute
title: 贡献方式
---
# 贡献方式
您可以通过多种方式为 UPage 做出贡献,无论您是开发者、设计师、文档撰写者还是用户,都能找到适合您的贡献方式。
## 报告问题
如果您发现了 bug 或有功能建议,请在 [GitHub Issues](https://github.com/halo-dev/upage/issues) 中提出。提交问题时,请尽可能提供以下信息:
- 清晰的问题描述
- 复现步骤
- 预期行为与实际行为
- 截图(如适用)
- 环境信息浏览器、操作系统、UPage 版本等)
## 提交代码
如果您想直接贡献代码,请遵循以下步骤:
1. [Fork](https://github.com/halo-dev/upage/fork) 项目仓库
2. 创建您的功能分支 (`git checkout -b feature/amazing-feature`)
3. 提交您的更改 (`git commit -m 'Add some amazing feature'`)
4. 推送到分支 (`git push origin feature/amazing-feature`)
5. 创建 Pull Request
### 代码贡献指南
- 确保您的代码符合项目的[代码规范](./code-standards.md)
- 为新功能编写测试
- 更新相关文档
- 确保所有测试通过
- 遵循[工作流程](./workflow.md)中的分支策略和 PR 流程
## 改进文档
文档对于任何项目都至关重要。您可以通过以下方式改进 UPage 的文档:
- 修复文档中的错误或不准确之处
- 添加缺失的信息或示例
- 改进文档的结构和可读性
- 翻译文档到其他语言
### 文档贡献步骤
1.`docs/content` 目录中找到相关的 Markdown 文件
2. 进行必要的更改
3. 在本地预览更改:`pnpm docs:start`
4. 提交 Pull Request
## 设计贡献
如果您是设计师,您可以通过以下方式贡献:
- 改进用户界面设计
- 创建图标和插图
- 设计宣传材料
- 提供用户体验建议
## 测试和反馈
即使您不是开发者,您也可以通过以下方式做出重要贡献:
- 测试新功能和版本
- 提供详细的反馈
- 报告使用过程中遇到的问题
- 提出改进建议
## 分享和推广
您也可以通过以下方式支持 UPage
- 在社交媒体上分享项目
- 撰写关于 UPage 的博客文章或教程
- 在相关论坛和社区中推荐 UPage
- 为项目加星标Star
## 社区支持
帮助其他用户解决问题也是一种重要的贡献方式:
- 回答 [GitHub Discussions](https://github.com/halo-dev/upage/discussions) 中的问题
- 帮助新用户入门
- 分享您的使用经验和最佳实践
## 感谢您的贡献
无论您以何种方式支持和参与 UPage 项目我们都由衷地感谢您的每一份贡献。正是因为有诸多像您这样的社区成员的支持和参与UPage 才能不断成长和进步。每一个问题报告、每一行代码、每一份文档改进以及每一次分享都是宝贵的。