Git分支命名约定

2020-05-02 18:00:00

Git分支是一个强大的工具,可以将正在进行的工作作为团队的一部分进行组织,并确保软件交付保持有效。如果你现在使用Git,你很有可能使用著名的Git-Flow或最新的GitHub Flow。这两个工作流在很大程度上依赖于有效地使用分支-而命名新分支是许多开发人员努力解决的问题。

推荐的约定和格式如此之多,但有时遵循这些约定本身就很痛苦。在这里,我们概述了一个简单的git分支命名约定,该约定易于遵循,并处理最常见的用例。

大多数约定建议在分支机构名称前面加上前缀,如Hotfix-、Feature-、Chore-或任务分类的其他变体。实际上,如果您使用的是问题跟踪器,那么您无论如何都是在问题跟踪器中标记任务的类别--此外还有更多的附加上下文。使用这些分类前缀,这至少看起来是多余的,在最坏的情况下,在命名分支时需要额外的决策。以问题跟踪器ID开头很方便,.。

在大多数情况下,在问题跟踪器中创建的问题用于跟踪团队的进度。将相关工作分支与每个任务相关联变得很容易-特别是当每个开发人员同时处理许多问题时。

在问题跟踪器中搜索和过滤要容易得多。一旦您知道了问题编号,使用自动完成在本地GIT树中查找分支就变得很容易了。

➜超级机密-项目GIT:(主)GIT签出72x722-添加-计费-模块-应用代码审阅的建议720-子模块-RC722-添加-计费-模块723-修复-突出显示728-修复-主页-css。

虽然在大多数情况下,使用问题跟踪器ID本身就足以识别项目中的唯一分支,但可能需要更多细微差别。例如,可能有多个分支机构需要处理一个问题,可能由不同的人负责。

在问题ID之后使用简短的、可操作的任务描述符。这使得分支机构名称可识别、清晰且易于搜索,以防您手头没有问题ID。确保描述符简洁,但描述性足以让您对分支机构中发生的事情有一个了解。

这有点固执己见,但是在分支名称中使用连字符是很好的分隔符。你也可以用下划线_。不过,关键是要始终如一。

仅此而已--只需牢记以下三条规则。没有复杂的命名方案或要遵循的规则,团队中的每个人都很容易保持一致。给事物命名有时可能很困难,拥有简单的启发式方法会很有帮助。在一个几乎每个人都在使用某种问题跟踪的世界里,这种方法使git分支命名变得尽可能简单。

DeepSource帮助您在代码检查期间自动查找并修复代码中的问题,例如错误风险、反模式、性能问题和安全缺陷。使用GitHub或GitLab帐户设置需要几分钟,并且支持Python、Go和Ruby。JavaScript即将问世。

注册DeepSource