This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
Инструкция по созданию коммитов
Аннотация
Описываются правила формирования commit-messages.
Рекомендации по коммит-сообщениям
Общее правило: коммит-сообщения должны быть такими, чтобы на их основе можно было бы хорошо понимать, что именно было сделано. Если коммит-сообщения составлены правильно, то они вполне могут заменить собой отчет о проделанной работе (сам отчет в этом случае не требуется).
Кроме того, на основе коммит-сообщений можно формировать список изменений для всего проекта.
Детализация коммит-сообщений
В общем случае коммит-сообщение может состоять из заголовка и тела (которые отделяются друг от друга пустой строкой).
На практике в подавляющем большинстве случаев требуется только заголовок. И только если работа требует какой-то особой детализации — можно добавить тело.
Заголовок
Рекомендации по формированию заголовка:
- не более 50 символов (желательно);
- не более 72 символов (строго);
- первая буква — заглавная;
- в конце заголовка точка не ставится;
- первое слово — краткое страдательное причастие прошедшего времени в форме, согласованной с объектом (в единственном или множественном числе): например, «Создан...», «Исправлен...», «Устранены...» и так далее.
Тело
Если требуется детализировать или разъяснить проделанную работу, можно добавить к заголовку тело коммит-сообщения.
Тело, если оно есть, отделяется от заголовка одной пустой строкой. В конце тела ставится точка.
Общие пожелания и примеры
Сообщение должно быть кратким, но информативным. Оно не должно содержать общих фраз.
Хорошие примеры (заголовки):
- Создана новая страница;
- Исправлены ошибки в описании Пользователя;
- Добавлены новые сущности в Глоссарий;
- Устранены несоответствия в описании событий, отправляемых Календарём;
- Исправлены «битых ссылок» и т.д.
В целом, сообщение должно быть прямым продолжением фразы
«Благодаря принятию этого коммита в проекте... »
Саму эту фразу, конечно же не нужно добавлять в сообщение. Её можно просто держать в уме.
Применение коммит-сообщений к объектам
Общее правило: чем выше детализация — тем лучше. Однако, всё должны иметь разумные пределы.
В целом, вполне допустимо применить одно коммит-сообщение (особенно, если оно содержит детальное тело) даже к группе файлов. Но лучше было бы — к отдельным логическим блокам (абзацам, вкладкам, разделам или страницам).