8. Соглашение о коммитах

8. Соглашение о коммитах

❗

За основу взято руководство RS School (opens in a new tab)

8.1. Требования к именам коммитов

  • Названия коммитов должны быть согласно гайдлайну (opens in a new tab)
  • Для того чтобы удобно было контролировать таски в Jira (opens in a new tab) делаем следующее. В начале коммита добавляем имя таски ST-1057, TM-15, IT-535 (буквы - сокращенное имя проекта, цифры - порядковый номер задачи)

  • Тип коммита должен быть только в нижнием регистре (feat, fix, refactor, docs и т.д.)
  • Должен использоваться present tense ("add feature" not "added feature")
  • Должен использоваться imperative mood ("move cursor to..." not "moves cursor to...")
✅ Пример правильного сообщения о коммите
ST-1057 feat: add banner

8.1.1. Примеры имен коммитов

  • init: - используется для начала проекта/таска. Примеры:
init commit message
ST-1057 init: start youtube-task
ST-1057 init: start mentor-dashboard task
  • feat: - это реализованная новая функциональность из технического задания (добавил поддержку зумирования, добавил footer, добавил карточку продукта). Примеры:
feat commit message
ST-1057 feat: add basic page layout
ST-1057 feat: implement search box
ST-1057 feat: implement request to youtube API
ST-1057 feat: implement swipe for horizontal list
ST-1057 feat: add additional navigation button
ST-1057 feat: add banner
ST-1057 feat: add social links
ST-1057 feat: add physical security section
ST-1057 feat: add real social icons
  • fix: - исправил ошибку в ранее реализованной функциональности. Примеры:
fix commit message
ST-1057 fix: implement correct loading data from youtube
ST-1057 fix: change layout for video items to fix bugs
ST-1057 fix: relayout header for firefox
ST-1057 fix: adjust social links for mobile
  • refactor: - новой функциональности не добавлял / поведения не менял. Файлы в другие места положил, удалил, добавил. Изменил форматирование кода (white-space, formatting, missing semi-colons, etc). Улучшил алгоритм, без изменения функциональности. Примеры:
refactor commit message
ST-1057 refactor: change structure of the project
ST-1057 refactor: rename vars for better readability
ST-1057 refactor: apply eslint
ST-1057 refactor: apply prettier
  • docs: - используется при работе с документацией/readme проекта. Примеры:
docs commit message
ST-1057 docs: update readme with additional information
ST-1057 docs: update description of run() method
7. Комментарии9.1. Import