Git中的分支描述

Git中是否有一种为分支提供“描述”的方法?

虽然我尝试使用描述性的名称，但在一个分支上工作一段时间，有时会使我对为什么要创建其他一些主题分支的记忆变得模糊。我尝试为分支使用描述性的名称，但我认为“描述”(关于分支目的的简短说明)会很好。

当前回答

git config --global --add alias.about '!describe() { git config branch."$1".description; }; describe'

命令将定义全局选项别名。About as shell表达式。如果在存储库中运行git about <branch>，将显示分支的描述。

其他回答

我非常确定目前不支持该特性。我认为最好的办法是创建一个描述文本文件，基本上是一个README，在包含您想要的信息的分支中。

Use

git branch --list -v

显示上游分支:

git branch --list -vv

添加-r只显示远程或-a显示远程和本地。

只使用:

git config branch.<branch name>.description

在该表扬的地方表扬: https://glebbahmutov.com/blog/git-branches-with-descriptions/

Git 1.7.9支持这一点。从1.7.9版本说明中可以看到:

 * "git branch --edit-description" can be used to add descriptive text
   to explain what a topic branch is about.

你可以在提交6f9a332、739453a3、b7200e8时看到该特性早在2011年9月就已经引入:

struct branch_desc_cb {
  const char *config_name;
  const char *value;
};

--edit-description::

打开编辑器并编辑文本以解释分支的用途，以供各种其他命令使用(例如请求-拉取)。

注意，它不适用于分离的HEAD分支。

这个描述被脚本request-pull使用:参见commit c016814783，还有git merge——log。

request-pull是一个脚本，用于总结两次提交到标准输出之间的更改，并在生成的摘要中包含给定的URL。

不幸的是，你不能推送描述，因为它们存储在你的配置中，这对于团队中的分支来说是无用的。

如果您最终要使用README，请创建一个git别名，修改git checkout，以便在每次切换分支时显示您的README。

例如，在~/中添加这个。Gitconfig，在[alias]下

cor = !sh -c 'git checkout $1 && cat README' -

在此之后，您可以运行git cor <branch_name>来切换分支，并显示您要切换到的分支的README。

推荐文章