GitHub 分支命名规则

由 Mux 赞助的 DEV 全球展示挑战赛：展示你的项目！

统一的分支命名规范是代码审查最佳实践的一部分。

1. 请在分支名称中使用工单 ID

   如果使用票号，则跟踪票务将非常容易，而且每张票都是唯一的。

   思考分支名称并不需要花费太多时间，而且使用起来也更方便。

2. 在工单 ID 前缀后，添加任务的简短描述。

   如果您与多个成员共同处理同一个工单，那么在工单 ID 后添加简短描述将非常有用。

Git 中有两种主要的命名约定风格：用连字符 (-) 分隔或用斜杠 (/) 分隔。

1. 特色/XXX

例如：features/首页

1. 发布/XXX

例如：releases/1.1

1. 热修复/XXX

例如：热修复/搜索

你还可以将推送规则集成到项目中，这看起来非常棒而且也很容易上手。它确实能改善代码提交的结构。

我们如何将推送规则集成到 GitLab 中 🤔

推送规则本质上pre-receive Git hooks就是可以通过用户友好的界面轻松启用的规则。

在 GitLab 帐户中转到项目 => 设置 => 仓库 => 推送规则

你也可以按项目进行定义，这样不同的项目就可以有不同的规则。

1. 提交消息时需包含特定引用

   假设每次提交都应该引用一个 JIRA 问题。

   例如：JIRA-11

   然后我们可以编写一个正则表达式，要求在提交消息中包含 JIRA 问题，例如JIRA\-\d+：

2. 限制分支名称

   如果贵公司对分支名称有严格的规定，您可能希望分支以特定名称开头。这种方法支持依赖于分支名称的不同 GitLab CI/CD 作业（例如 feature、hotfix、docker、android）。

   任何与推送规则不符的分支名称都会被拒绝。

3. 启用推送规则

4. 阻止将密钥推送到存储库

参考🧐

• Atlassian
• 预接收 Git 钩子
• 推送规则