Правила работы в git

Именование веток

  • Имя ветки должно отображать её суть и предназначение.
  • В имени ветки использовать стоит только цифры, латинские буквы в нижнем регистре и дефисы
  • Если ветка создается под какую-то конкретную задачу и решено назвать ее в соответствие с задачей, то в начале пишется номер задачи и через дефис после него пишется описание задачи: 34-auth-form-refactoring
  • Если это более долгоживущие ветки или постоянные, то есть устоявшиеся названия:
    • Основная ветка - master / main
      main периодические в github называется основная ветка (считается более современной, чем master)
    • Ветка разработки - dev / devel / develop
    • Ветка тестирования - test / staging и т.д.
    • “Прод” ветка - production
    • Hotfix ветки - fixes / hot-fixes / hotfixes

Что должно попадать в коммит?

  • Реализованная задача или часть
  • Результат работы за какой-то период
    Например, в конце рабочего дня можно делать коммит, если за день их не делал

!! Не нужно коммитить каждые 5 минут.


Комментарии к коммитам (messages)

Они должны отражать суть коммита.
Они еще и могут соответствовать стандартам, принятым в компании. Один из популярных стандартов это Conventional Commits. Там подробно расписано с примерами - что и как писать в message-и коммитов.


git