Стиль именования коммитов в git

Для именования коммитов можно воспользоваться следующими 7-ю правилами:
1. Разделяй название коммита с описанием пустой стройкой
Пример:
Обновить документацию

Необходимо добавить новые комментарии к публичным
методам класса Person.

2. Название коммита не должно превышать 50 символов
GitHub к примеру обрезает большие строки в названии коммита.

3. Название коммита должно начинаться с большой буквы
Правильно: Accelerate to 88 miles per hour
Не правильно: аccelerate to 88 miles per hour

4. Не нужно ставить знаки препинания в конце названия коммита
Правильно: Accelerate to 88 miles per hour
Не правильно: аccelerate to 88 miles per hour.

5. Используй повелительное наклонение в названии коммита (в неопределенной форме)
Многие используют баг-трекер. Задача в баг-трекере должна отвечать
на вопрос «Что сделать?».
К примеру:
Название задачи: «Написать скрипт работы с почтой»
Описание: «Написать скрипт для работы с почтой.
Скрипт должен принимать на вход текст письма, а на выход
отдавать результат отправки письма.»

Правильный коммит должен правильно завершать фразу:
If applied, this commit will your subject line here
Правильно:
If applied, this commit will refactor subsystem X for readability
If applied, this commit will update getting started documentation
Не правильно:
If applied, this commit will fixed bug with Y
If applied, this commit will changing behavior of X

6. Длина одной строки в описании не должна превышать 72 символа
Т.к. git не переносит автоматически текст описания. То нам нужно сделать это вручную.
Обычно стараются запихнуть весь текст на 80-символьную консоль. 8 — символов отводится
на отступы.

7. В описании отвечайте на вопрос «Что сделать? и Зачем это делать?» против «Как это сделано?»

Более подробно можно прочитать тут:
chris.beams.io

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *


× шесть = 54

Можно использовать следующие HTML-теги и атрибуты: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>