Шпаргалка по оформлению коммитов

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

• Названия коммитов должны быть согласно гайдлайну: общепринятые правила именования коммитов
• Должен использоваться present tense («add feature» not «added feature»)
• Должен использоваться imperative mood («move cursor to…» not «moves cursor to…»)

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

init: — используется для начала проекта/таска.

Примеры:

• init: start youtube-task
• init: start mentor-dashboard task

feat: — это реализованная новая функциональность из технического задания (добавил поддержку зумирования, добавил footer, добавил карточку продукта).

Примеры:

• feat: add basic page layout
• feat: implement search box
• feat: implement request to youtube API
• feat: implement swipe for horizontal list
• feat: add additional navigation button
• feat: add banner feat: add social links
• feat: add physical security section
• feat: add real social icons

fix: — исправил ошибку в ранее реализованной функциональности.

Примеры:

• fix: implement correct loading data from youtube
• fix: change layout for video items to fix bugs
• fix: relayout header for firefox
• fix: adjust social links for mobile

refactor: — новой функциональности не добавлял / поведения не менял. Файлы в другие места положил, удалил, добавил. Изменил форматирование кода (white-space, formatting, missing semi-colons, etc). Улучшил алгоритм, без изменения функциональности.

Примеры:

• refactor: change structure of the project
• refactor: rename vars for better readability
• refactor: apply eslint
• refactor: apply prettier

docs: — используется при работе с документацией/readme проекта.

Примеры:

• docs: update readme with additional information
• docs: update description of run() method

 

---

Оригинал: https://gist.github.com/Voloshin-Sergei/ffbec67c6d9fcb32b0df014ababba0e9