InstructionsWorkingGit

<- к содержанию

Правила хорошего тона в написании коммитов:

  1. Заголовок коммита должен начинаться с заглавной буквы, разделен от тела пустой строкой и содержать не более 50 символов. В заголовке используем повелительное наклонение. Точку в конце заголовка ставить не нужно

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

  3. Текст коммита формируется из трёх частей:
    1. действие (добавление, исправление, рефакторинг…);
    2. сущность (документация, счета, главная страница…);
    3. подробности (задача №23, несуществующий пользователь, зависимости…) — необязательное поле.

    В теле коммита отвечайте на вопросы «что» и «почему», а не «как»

  4. Старайтесь давать достаточную информацию об изменениях, но не стоит давать излишние подробности. Тело коммита дожно содержать не более 72 символов

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

  6. Найдите свой стиль. Необязательно изобретать велосипед. Ознакомьтесь с различными практиками, соблюдайте требования команды