Question

可能重复：
  How do you annotate a branch?
  Branch descriptions in git

我有一个有很多分支的回购。也许12个左右，他们很快就不会合并成大师了。

有没有办法在git中记录每个分支的用途？

我寻求的是一个分支，提交消息是一个提交。

我不认为标签是我想要的，因为标签不遵循HEAD，因为我向分支添加了更多提交。

我可以编写一个明文文件，列出每个分支的状态和一些注释，但不明显的是文本文件将进入哪个分支。

为了澄清，我确实为我的分支命名。但我希望能够有一个描述。例如，我想写分支RTPhase：

该分支增加了支持曲率和相位实时分析的功能。作为折衷，它比其他分支运行得更慢，因为它使用的计算平均曲率等函数尚未针对速度进行优化。

Answer 1

我要解决的问题是设计一个我可以严格遵守的惯例。

我的主“释放”分支称为“主”。我的“修补程序”分支（用于生产中的修复程序）称为“修补程序”。我在下一个版本中进行开发的分支称为“dev”。

然后我把那些分支的任何分支都带上了名字。因此，我正在处理地图的功能分支称为“dev / maps”。我有一个调查功能，我在一个分支“dev / survey”中添加。

如果我有一个需要任何实时的修补程序，我可能会分支到“hotfix / short-description-of-branch”。

斜杠在分支名称中没有任何语法值，它只是文本，但我用它来暗示“内部”。

Answer 2

你可能不喜欢它，但只是为了好玩（至少对我来说:)以下就是我要做的事情：

在您的分支机构中git notes add -m "this branch is for blah blah"

然后使用以下内容在您的仓库中写一个提交后的内容：

#!/bin/sh
git notes show HEAD~1
git notes copy HEAD~1 HEAD

另外添加git notes remove HEAD~1

使用git notes show查看分支的用途。 Tadaaa！：）

Answer 3

在不知道自己在做什么的情况下，您可能会发现一个工作流程支持工具更易于使用的不同工作流程。例如：http://nvie.com/posts/a-successful-git-branching-model/和关联的gitflow支持工具。

它本身没有分支描述，但是如果您添加了该功能，它可能会被接受。