Как выяснили многие программисты на собственном горьком опыте, добавление документации чрезвычайно важно для возможности легко вносить изменения в ваш код, исправлять проблемы, передавать другим и т. Д. То, что ваш код теперь имеет смысл, не означает, что он будет имеет смысл для вас через 6 месяцев (или даже через неделю). Вы, вероятно, привыкли документировать свой реальный код, но этой же практике следует придерживаться и при коммитах в системе контроля версий.

В Git есть несколько способов документировать ваши изменения, но в этой короткой статье мы сосредоточимся в основном на том, как это сделать для отдельных коммитов.

При просмотре репозитория на GitHub вы, вероятно, заметили сообщения рядом с файлом или папкой:

Эти сообщения обычно добавляются в репозиторий во время фиксации, хотя вы также можете задним числом добавить сообщения фиксации.

В GitHub сообщение рядом с файлом или папкой относится к последней фиксации, в которой этот файл / папка был изменен . Так что это не обязательно все из последней фиксации. В противном случае было бы не очень полезно, если бы GitHub отображал одно и то же сообщение о фиксации из последней фиксации для всех файлов.

Чтобы добавить это сообщение, вам нужно указать -m при выполнении git commit . Ваше сообщение должно быть сразу же после флага и заключено в кавычки. Пример этого выглядит так:

 $ git commit index.js -m "Fixed world-ending bug (#281)" 

Многострочные сообщения

Вы не всегда можете описать сложное изменение коротким однострочным комментарием. Интересной особенностью -m является то, что вы можете добавить несколько абзацев к своему сообщению, используя -m несколько раз в одной команде commit

 $ git commit index.js -m "My Changes" -m "- Fixed a critical bug" -m "- Probably added more bugs" 

Эти несколько сообщений в результирующем коммите будут выглядеть следующим образом:

 My Changes 
 - Fixed a critical bug 
 - Probably added more bugs 

Другой вариант, который зависит от используемой оболочки, - просто ввести одинарную или двойную кавычку и нажать [Enter]{.kbd} , не закрывая кавычки. Это хорошо работает в Bash, который не вводит команду, пока вы не закроете цитату:

 $ git commit index.js -m "My Changes 
 - Fixed a critical bug 
 - Probably added more bugs 
 " 

И, наконец, вам вообще не нужно использовать флаг -m Если вы опустите этот флаг, Git автоматически откроет текстовый редактор, чтобы вы могли ввести сообщение о фиксации.