Git не имеет никаких изначальных ограничений на имена веток. Ограничения часто вводятся самими разработчиками для улучшения понимания проделанной работы другими разработчиками.
Для именования веток стоит рассмотреть следующие пункты
/ (косой черты)Структура названия ветки
<group>/<name>[/<subname>]
Аналогично коммитам ветки рекомендуется разделять на группы.
| Группа | Расшифровка | Описание |
|---|---|---|
| feat | Feature (Новая функция) | Ветка ориентированная на создание новых функций |
| fix | Fix (Исправление) | Ветка ориентированная на исправление ошибок |
| test | Test (Тестирование) | Ветка ориентированная на тестирование |
Примеры:
git checkout -b feat/mongoengine-support
git checkout -b fix/ci-fix
Команда git checkout -b <branch name> создает и переключает на новую ветку с указанным названием.
Названия веток должны быть емкими и понятными. Не рекомендуется делать длинные названия.
Хорошо:
git checkout -b feat/mongoengine-support
Не хорошо:
git checkout -b feat/add-new-mongodriver-support-for-project/test
В случае если возникнет проблема с именованием, например, нужно создать несколько веток с приблизительно одинаковым именем, то стоит создать Issue или Проблему в проекте и сослаться на него.
git checkout -b feat/issue-457-mongoengine
git checkout -b fix/issue-505-mongoengine
Как распоряжаться ветками решать разработчику, однако не стоит создавать ветки для сохранения иди, все же не должны оставать неиспользуемые ветки в проекте. Последнее засоряет проект и усложняет поиск.
Ветки адаптеров имеют схожий принцип, как и ветки обычных проектов, однако стоит учитывать, что адаптер собирается и запускается только из ветки master, а значит после заврешния разработки в ветки её стоит объеденить или же смерджить merge. Создав запрос на объединение merge request, вы указываете ветку и куда её объединять, рекомендуется также объеденить все коммиты. В обязательном порядке ветка должна быть удалена, так как разработка над ней законичилась. Если нужно продолжить разрабатывать, то должна быть создана еще одна ветка с соответствующем названием.
В проекте требуется использовать описанную на данной странице конвенцию. Пример использования можно увидеть в одном из репозиториев проекта.