Gitで新しいブランチを作成するときにメッセージ/メモ/コメントを追加できますか？

Question

私は、同じタスクのいくつかの異なるバリエーションに30分を費やす可能性が最も高い探索的作業を行っています。アプローチ間を行き来できるように、gitで追跡したいと思います。また、ブランチが3つ、6つ、または9つある場合、それらを区別するために、ブランチ名よりも多くの情報が必要になる場合があります。

新しいブランチにコメントを添付する最もクリーンな方法は何ですか？

Christopher · Accepted Answer

ブランチの説明が必要です。

git branch --edit-description

これにより、エディターが開き、メタデータをブランチに添付できるようになります。あなたはそれを抽出することができます：

git config branch.<branch>.description

重要な注意事項：

これはローカルに保存されます。定義上、.git/configに格納されているため、プッシュできません。それでも、このユースケースではうまく機能します。
ブランチを削除すると、説明も削除されます。
git config --global branchdesc trueを設定すると、この説明をマージコミットにプッシュできます。これは、git merge --log <branch>を発行すると、ブランチの説明が株式マージコミットメッセージに強制されることを意味します。これには多くの用途があります。たとえば、これは私が雇用主でトピックブランチのリリースノートを追跡する方法です。