代码开发规范

概述

夜莺社区使用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行，尽量分成小块提交，以提高评审通过率。

解决冲突

在多人协作中，主分支可能发生变化，导致合并时出现冲突。建议定期将主分支的代码合并到当前开发分支，以减少冲突：

# 当前在开发分支上，dev-lyz-20250121
# 拉取最新主分支
git fetch origin

# 在开发分支上执行 rebase
git rebase origin/main

# 如果遇到冲突，解决冲突后继续 rebase：
git add <解决冲突的文件>
git rebase --continue

# 合并完成后，将你的开发分支推送到远程仓库（可能需要强制推送）：
git push origin dev-lyz-20250121 --force

提交PR

在GitHub上创建PR前，请确保：

• 代码本地编译通过。
• 与主分支没有冲突。
  
• 测试用例执行成功。

创建PR时，至少关联一个Issue，给PR添加评论，格式：fix #issue号

等待评审

提交PR后，等待评审。评审通过后，代码将合并到主分支。关注评审员的反馈，根据要求进行讨论和修改，直至达成一致。

执行合并

由评审人员点击“Merge pull request”按钮执行合并。如果没有冲突，代码将自动合并到主分支，并将本次合并状态标记为“Closed”。

---

欢迎您加入夜莺社区开发团队，遵循以上规范，将有助于项目的顺利进行！