GitHub分支命名的最佳实践指南

在 GitHub 上面，分支对于协作软件开发来说非常重要。除了保持项目组织有序外，使用一致且无歧义的分支命名规则，也使团队成员更容易快速理解每个分支的用途。下面是一些在 GitHub 项目中命名分支的最佳实践。

……

根据它们的用途给分支名称添加前缀有助于快速分类和识别这些分支。这里有一些常见的前缀，比如：

• 特性/：用于新特性。
• 修复错误/：用于修复代码中的错误。
• 紧急补丁/：用于紧急补丁，通常应用于生产环境。
• 设计/：用于用户界面或用户体验更新。
• 重构代码结构/：用于重构代码结构。
• 测试/：用于编写或改进测试。
• 更新文档/：用于文档更新。

前缀使用示例

• feature/用户身份验证
• bugfix/修复登录错误
• hotfix/紧急修复崩溃问题
• design/更新导航栏设计
• refactor/移除非必要代码
• test/增加单元测试

• doc/更新README文档

• • *

分支名称应该既简洁又明确。一个好的分支名称可以简洁地说明它的用途，而不冗长或含糊。这里有一些小建议：

• 使用短横线（-）分隔单词，以提高可读性。
• 避免使用通用术语，比如 更新、更改 或 内容 等。
• 集中描述该分支要解决的主要任务或问题。

这里有一些人的名字，如图所示。(https://imgapi.imooc.com/678df7d3096564bd07110542.jpg)

一些清晰的分支名称示例

1. 功能特性分支

• feature/add-user-profile（添加用户资料功能）

• feature/implement-chat-notifications（实现聊天通知功能）

  1. Bug修复

• bugfix/correct-date-display（修正日期显示错误）

• bugfix/fix-404-error（修复404错误）

  1. 设计更新

• design/improve-dashboard-ui（改进仪表盘UI）

• design/revise-mobile-layout（修订移动布局）

  1. 重构

• refactor/optimize-database-queries（优化数据库查询）

• refactor/simplify-api-routes（简化API路由）

  1. 热修复

• hotfix/security-patch（安全补丁）

• hotfix/fix-login-issue（修复登录问题）

  1. 文档更新

• doc/add-api-instructions（添加API说明）

• doc/update-contributor-guidelines（更新贡献者指南）

• • *

解释：将票号或标识符包含进来。

对于使用项目管理工具如 Jira 或 Trello 的团队，将工单编号或问题标识符包含在分支名中。这样可以将分支与对应的任务关联起来，方便跟进进度。

含票号的例子:

• feature/JIRA-1234-添加登录（功能：添加登录功能）
• bugfix/TICKET-567-解决崩溃（修复：解决崩溃问题）

• hotfix/ISSUE-890-修复API（紧急修复：修复API问题）

• • *

每个团队都有自己的特点，因此制定一个适合所有人的分支策略至关重要。在项目的贡献指南或 README 文件中记录命名约定，以便新贡献者可以轻松遵循这些约定。

• 改进的协作：团队成员可以快速理解分支的目的，无需额外背景信息。
• 更便捷的导航：查找特定分支变得更加简单。

• 更好的自动化：许多CI/CD工具可以利用结构化的分支名称来自动执行工作流，例如将hotfix/分支自动部署到生产环境。

• • *

通过遵循这些最佳实践，你可以简化你的GitHub工作流，让所有参与者更轻松地贡献。一致性是关键，所以从今天起使用分支命名约定吧！

关注,跟我一起：Github 领英 Threads