Правила заполнения коммитов - NurOrNuLL/ESDP-AP-5-6-TEAM-2 GitHub Wiki

Правила заполнения коммита через commitizen

Для коммитов будем использовать commitzen с типами:

  • fix – при исправлении бага
  • feat – при добавлении нового функционала
  • refactor – при улучшении рабочего кода
  • build – при добавлении дополнительных библиотек через pip

Шаги:

  1. Выбираем тип коммита
  2. Пропускаем выбор файла нажав enter
  3. Пишем краткое описание коммита
  4. Если тип комита feat, мы должны написать описание нашего нового функционала
  5. No
  6. Пишем "Связано: #num" вместо num номер тикета

Если у вас не установлен commitzen можете установить перейдя по этой ссылке https://commitizen-tools.github.io/commitizen/ и следуя инструкции.

Примеры коммита через commitzen:


fix: Исправление входа авторизации

Не проверял на ошибку логин и пароль

Связано: #1



feat: Добавить функционал

Добавил функционал просмотра списка пользователей

Связано: #2



refactor: Изменить название класса List

Изменил название класса List на ListView

Связано: #3