# 贡献指南 感谢您对 AIOT 项目的兴趣！本指南将帮助您有效地为项目做出贡献。 ## 🚀 开始贡献 ### 第一步：设置开发环境 ```bash # 克隆仓库 git clone https://github.com/your-org/aiot.git cd aiot # 按照你的端的指南配置环境 # 后端：docs/03-backend/01-setup.md # 前端：docs/04-frontend/01-setup.md # 移动：docs/05-mobile/01-setup.md ``` ### 第二步：阅读编码规范 - [代码风格指南](10-standards/01-code-style.md) - [命名规范](10-standards/02-naming-conventions.md) - [Git 工作流](10-standards/03-git-workflow.md) - [Commit 信息规范](10-standards/04-commit-messages.md) ### 第三步：创建 Feature 分支 ```bash git checkout -b feature/your-feature-name ``` ### 第四步：编写代码和测试 - 遵循编码规范 - 添加单元测试 - 确保测试通过 ### 第五步：提交 Pull Request 详见：[代码审查流程](10-standards/05-code-review.md) ## 📋 贡献类型 ### 🐛 Bug 修复 1. 创建 Issue 描述 Bug 2. Fork 仓库 3. 创建修复分支：`git checkout -b fix/issue-number` 4. 提交 PR，引用 Issue ### ✨ 新功能 1. 讨论功能设计（创建 Discussion 或 Issue） 2. Fork 仓库 3. 创建功能分支：`git checkout -b feature/feature-name` 4. 提交 PR 描述功能和测试 ### 📖 文档改进 1. 编辑相关 Markdown 文件 2. 提交 PR 3. 使用 Preview 功能检查格式 ### 🎨 UI/UX 改进 1. 在 Issue 中提出建议（包括设计稿） 2. 讨论和反馈 3. 实现并提交 PR ## 📝 Commit 信息规范 遵循 [Conventional Commits](https://www.conventionalcommits.org/) 规范： ``` ():