Могу ли я добавить сообщение/примечание/комментарий при создании новой ветки в Git?

Я занимаюсь исследовательской работой, где, скорее всего, буду тратить 30 минут на несколько разных вариантов одной и той же задачи. Я хочу отслеживать их в git, чтобы я мог прыгать назад и вперед между подходами. И если есть 3 или 6 или 9 ветвей, мне может понадобиться дополнительная информация, чем имя ветки, чтобы разделить их.

Каков самый чистый способ добавления комментария к новой ветке?

Ответ 1

Вам нужны описания ветвей:

git branch --edit-description

Это откроет ваш редактор и позволит вам прикреплять метаданные к ветке. Вы можете извлечь его с помощью:

git config branch.<branch>.description

Несколько важных заметок:

Это сохраняется локально. По определению он не может быть нажат, поскольку он хранится в .git/config. Все равно он отлично работает для этого варианта использования.
Если вы удалите ветвь, описание также будет удалено.
Вы можете вывести это описание в коммиляцию, если вы установите git config --global branchdesc true. Это означает, что при выпуске git merge --log <branch> это приведет к тому, что описание ветки будет передано в сообщение фиксации запаса. Это имеет много применений. Например, так я отслеживаю заметки выпуска ветки темы у своего работодателя.