Если вы все еще называете свои ветки небрежно, например «islamBranch1», пришло время изучить силу правильного соглашения об именах. Почему? Потому что систематическое соглашение об именах является краеугольным камнем единообразия.

Когда вы поддерживаете последовательность в своем подходе к именованию, это проливает свет на рабочий процесс вашей команды, процесс разработки вашего продукта и проблемы, с которыми вы сталкиваетесь. Итак, если вы никогда раньше не думали о таком соглашении об именах, пришло время обновить подход вашей команды!

Важность хорошего соглашения об именах

Хорошо структурированное соглашение об именах в Git касается не только эстетики; речь идет об эффективности и ясности. Вот несколько правил, которые помогут вам установить хорошее соглашение об именах:

  1. Последовательность. Используйте одно и то же соглашение об именах для всех ваших репозиториев и ветвей.
  2. Краткость. Названия должны быть короткими, но описательными.
  3. Подходящие символы. Используйте дефис (-) или подчеркивание (_) вместо верблюжьего регистра (myBranchName).
  4. Строчные буквы. Используйте строчные буквы для удобства чтения (например, это ветка).
  5. Используйте теги, а не ветки для версий. Ветви не предназначены для управления версиями; используйте теги Git для этой цели.
  6. Префиксы для идентификации. Используйте префиксы для идентификации типа ветки, например функция/имя, оперативное исправление/имя или ошибка/имя.
  7. Избегайте пробелов. Пробелы могут вызвать ненужную путаницу; избежать их.

Если вы используете инструменты управления проектами, такие как Jira или TFS, полезно использовать идентификаторы из них, чтобы связать функцию с пользовательской историей.

Примеры соглашений об именах

Предположим, вы работаете над функцией входа в систему с идентификатором истории, равным medium-78210. Вы можете назвать свою ветку, используя различные соглашения, такие как:

  1. <prefix>/<story-id> -> характеристика/средний-78210
  2. <prefix>/<story-id-name> -> функция/средний-78210-логин

Для ошибок вы можете следовать той же схеме: Bug/medium-31421.

Если ваш процесс не включает автоматизацию, CI или какую-либо интеграцию в этой ветке, вы можете выбрать более простое соглашение об именах, например функция/логин, хотя это не рекомендуется.

Не забывайте

  • Быть коротким
  • Подумай дважды
  • Сделать эффективным