Question

我想为在分支机构上完成的工作添加简要说明/理由。只有一两句话，但远远超过可以通过分支名称传达。不幸的是，我还没有找到一种明确的方法来实现这一目标。

git branch --edit-description命令似乎是理想的，除了它，因为它存储在repo配置中，它不能被推送。如果文档无法被其他人阅读，那么该文档并没有多大帮助。我想到了两种选择，但两者都存在语义问题。

第一种是将文档存储在存储库内容中。我发现这个选项没有吸引力，因为它会污染＆＃34;存储库内容，因为它有副作用 - 特别是在合并时。

另一种方法是使用git commit --allow-empty创建一个没有更改的提交。这仍然会破坏提交的语义，但至少会将元数据保留在存储库之外。

我目前倾向于使用空提交技术，但还有其他选择吗？我忽视的其他问题？

实现这一目标的典型方法是什么？

Answer 1

我不确定这是一个更好的选择，但是......

假设这是一个不会被重新定义的分支，那么你可以在初始分支点创建一个带有与分支类似名称的带注释标签，然后使用标签的提交消息来描述分支。 / p>

所以而不是

git checkout -b my_feature SOME_START_POINT

你会有

git tag -m "Startpoint of the my_feature branch  which is for ...." MY_FEATURE SOME_START_POINT
git branch my_feature MY_FEATURE

或其他一些命名方案，如my_feature_start_point等。

这些信息不会与分支本身相关联，但会以人类根据需要解决的方式进行关联。