Skip to main content

Branch 规范

目标

统一社区和开发者代码库的分支管理。

代码仓库

社区仓库

由社区在github上创建的代码仓库。这个仓库只维护main分支和定期发布的tag分支。tag分支命名： v<主版本>.<次版本>.<修订>

个人仓库

登陆github，访问社区代码仓库并fork到个人账户下的仓库。通常也只维护main分支，开发者可以根据自己的习惯创建开发分支，最终这些代码测试稳定后，先合并到个人仓库的mian分支。

 

 

开发分支创建

开发者可以使用以下命令创建自己的开发分支：

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”。

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

Back to top