代码开发规范
概述
夜莺社区使用GitHub进行代码、需求和BUG的维护与管理。作为新加入的开发者，您需要熟悉常用的Git命令，遵循文档和代码驱动的原则，以确保每一步都有记录，避免争议并便于后续迭代。
CI/CD 要求
确保代码通过CI/CD流水线的所有检查项。
分支规划
| 分支类型 | 描述 |
|---|---|
| 主分支 | 名称为 main，为默认分支，合并的代码需保证稳定性。 |
| 开发分支 | 基于主分支创建，命名格式为 dev-<姓名首字母缩写>-<日期>。 |
| 版本分支 | 基于主分支打的TAG，命名格式为 v<主版本>.<次版本>.<修订>。 |
开发分支创建
开发者可以使用以下命令创建自己的开发分支：
git checkout -b dev-lyz-20241228
合并代码流程
提交代码
及时将开发分支的代码提交到Git仓库，以防止因设备故障导致的代码丢失：
git push origin <开发分支名，例如 dev-lyz-20250121>
提交合并
完成开发和测试后，将代码合并到主分支：
- 每次合并不超过1000行，尽量分成小块提交，以提高评审通过率。
解决冲突
在多人协作中，主分支可能发生变化，导致合并时出现冲突。建议定期将主分支的代码合并到当前开发分支，以减少冲突：
git checkout main
git pull origin main
git checkout <开发分支>
git merge main
提交PR
在GitHub上创建PR前，请确保：
- 代码编译通过。
- 与主分支没有冲突。
- 关联相关Issue，格式为：
fix #issue号。 - 测试用例执行成功。
等待评审
提交PR后，等待评审。评审通过后，代码将合并到主分支。关注评审员的反馈，根据要求进行讨论和修改，直至达成一致。
执行合并
由评审人员点击“Merge pull request”按钮进行合并。如果没有冲突，代码将自动合并到主分支，并将本次合并状态标记为“Closed”。
欢迎您加入夜莺社区开发团队，遵循以上规范，将有助于项目的顺利进行！