如何在远程存储库中记录分支？

我想为分支上正在完成的工作添加一个简短的说明/基本原理。只有一两句话，但远远超过可以通过分行名称进行沟通。不幸的是，我一直无法找到一个明确的方式来完成这一点。如何在远程存储库中记录分支？

该git branch --edit-description命令将似乎理想，除了，因为它存储在repo配置，它不能被推送。如果其他人无法阅读，那么这些文档就没有太大用处。想到两种选择，但都存在语义问题。

第一个是将文档存储在存储库内容中。我觉得这个选项不吸引人，因为它“污染”了储存库内容，并且因为它有副作用 - 特别是在合并时。

另一种是使用git commit --allow-empty来创建一个没有变化的提交。这仍然违反了提交的语义，但至少将元数据保存在存储库中。

我目前倾向于使用empty-commit技术，但是还有其他的选择吗？我忽略的其他问题？

完成此操作的典型方法是什么？

2014-10-05 Ben Blank

不是一个只有git的或完整的解决方案，但是如果您使用某种形式的售票系统跟踪所有工作，则分行名称中的票证ID可以提供帮助。就我个人而言，我甚至不知道git分支可能有描述 - 我很好奇，即使您能够远程获得它，也有多少人会看到它。 – 2014-10-05 19:55:42

我不知道这是一个选择的更好，但...

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

所以不是

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一些其他的命名方案等

的信息不会与分支本身有关，但会以人类可以根据需要找出的方式进行关联。

2014-10-05 19:57:17

回答