[解決済み】Gitでのブランチ記述

質問

Git でブランチに「説明」を付ける方法はありますか？

私は説明的な名前を使うようにしていますが、一つのブランチでしばらく作業をしていると、なぜ他のトピックのブランチを作ったのか、記憶が薄れてしまうことがあります。私はブランチに説明的な名前を使うようにしていますが、「説明」（ブランチの目的についての短いメモ）があるといいと思います。

解決方法は？

Git 1.7.9で対応しました。から 1.7.9リリースノート :

 * "git branch --edit-description"を使用すると、説明文を追加することができます。
   トピックブランチが何であるかを説明するために使用します。

この機能が導入されたのは2011年9月のコミットです。 6f9a332 , 739453a3 , b7200e8 :

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

--edit-description::

エディタを開いて、ブランチが何のためにあるのかを説明するテキストを編集し、他のさまざまなコマンド（たとえば request-pull ).

デタッチドHEADブランチでは動作しないことに注意してください。

その記述はスクリプトrequest-pullで使用されています: 参照。 コミット c016814783 のみならず git merge --log .

request-pull は、二つのコミット間の変更点を標準出力にまとめ、生成された要約に指定された URL を含めるために使われるスクリプトです。

[@AchalDave より] 残念ながら、説明文は設定に保存されるためプッシュできず、チーム内でブランチを文書化する目的では役に立ちません。