提交指南#
分支规则#
以相应的问题编号开始分支名称(咨询、非自动化)#
理由#
- 开发者可以快速找到对应的 issue.
- 它对工具很有帮助.
- 它与 GitHub 的默认行为一致.
异常#
如果没有相应的问题,您可以忽略此规则.
示例#
123-add-feature
参考资料#
使用 dash-case 作为分支名称的分隔符 (advisory, non-automated)#
理由#
- 它与 GitHub 的默认行为一致.
示例#
123-add-feature
参考资料#
使分支名称具有描述性(建议性、非自动化)#
理由#
- 可以避免名称冲突.
- 开发人员可以了解分支的目的.
异常#
如果您已经提交了 PR,则不必更改分支名称,因为您需要重新创建 PR,这很吵且浪费时间. 下次要小心.
示例#
通常最好以动词开头.
123-fix-memory-leak-of-trajectory-follower
提交规则#
签署你的提交 (必需,自动)#
开发人员必须证明他们编写了或以其他方式有权提交他们为项目贡献的代码.
理由#
否则,将导致复杂的许可证问题.
示例#
git commit -s
feat: add a feature
Signed-off-by: Autoware <autoware@example.com>