☰

Gitのブランチの説明 質問する

tag-icon • tag-icon git branch task-tracking
Gitのブランチの説明 質問する

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

わかりやすい名前を使用するようにしていますが、1 つのブランチでしばらく作業していると、他のトピック ブランチを作成した理由が思い出せなくなることがあります。ブランチにはわかりやすい名前を使用するようにしていますが、「説明」(ブランチの目的に関する短いメモ) があるとよいと思います。

ベストアンサー1

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は、2 つのコミット間の変更を標準出力に要約するために使用されるスクリプトであり、生成された要約に指定された URL が含まれます。

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

おすすめ記事