Оформление коммитов

• Сообщения коммитов пишутся на русском языке

• Любое сообщение должно начинаться с номера задачи в Яндекс Трекер обрамленного в квадратные скобочки, например: [WEB-123]

• Если коммит не привязан к конкретной задаче, номер опускается

• Сообщение начинается с заглавной буквы

• После номера задачи идет описание действия – глагол в прошедшем времени:

  • Добавлен(о/а)

  • Обновлен(о/а)

  • Удалено(о/а)

  • Изменен(о/а)

  • Исправлен(о/а)

  • Использован(о/а)

  • Разрешен(о/а)

  • Отрефакторен(о/а)

• Точка в конце сообщения не ставится

• Длина сообщения не должна превышать 75-100 символов

• (опционально) Более подробная информация об изменениях может быть добавлена в тело сообщения комммита

Пример информативного сообщения коммита

git commit -m "[WEB-123] Добавлен метод внутреннего API для получения курсов валют"

Сообщение должно быть кратким, но информативным.

Примеры неинформативных сообщений:

• add method for EntriesGeneratorMethod

• task/WEB-123

• master.

• WB fix

• add icon for menu

• fix

• upd

Пример хорошо оформленного сообщения

[WEB-123] Добавлено перенаправление пользователя на исходную страницу после входа в систему
 
https://tracker.yandex.ru/WEB-123
 
Ранее после успешного входа пользователи перенаправлялись на главную страницу приложения,
что не так удобно по сравнению с перенаправлением на страницу, с которой выполнялся вход.
 
* Хранение исходного пути в переменной сессии
* Перенаправление на сохраненное место после успешного входа пользователя в систему

Полезные материалы

• My favourite Git commit