Правила использования Git

Записи коммитов

Формат записи: type(область[необязательная]): тема

1. type

• feature: новая функциональность
• fix: исправление ошибки
• docs: документация
• style: форматирование (изменения, не влияющие на выполнение кода)
• refactor: рефакторинг (изменения, не добавляющие новую функциональность и не исправляющие ошибки)
• test: добавление тестов
• chore: изменения в процессе сборки или вспомогательных инструментах
• optimize: оптимизация

2. область

Область используется для указания области, затронутой коммитом, например, уровень данных, уровень управления или уровень представления, и т.д. Это зависит от проекта.

3. тема

Тема — это краткое описание цели коммита, не более 50 символов.

• Начинается с глагола, используется настоящее время первого лица, например, change, а не changed или changes
• Первый символ должен быть строчной буквой
• Не заканчивается точкой

Примеры:

feature(message-center): разработка функции записи сообщений. Или feature: разработка функции записи сообщений.

Правила названия веток

Формат названия ветки: {type}_{дата}_{описание}_{разработчик}

1. type- feature: новая функциональность

• fix: исправление ошибки
• docs: документация
• style: форматирование (изменения, не влияющие на выполнение кода)
• refactor: рефакторинг (изменения, не добавляющие новую функциональность и не исправляющие ошибки)
• test: добавление тестов
• chore: изменения в процессе сборки или вспомогательных инструментах
• optimize: оптимизация### 2. дата

Формат даты: год-месяц-день (2023-04-23)

3. описание

Например, отправка сообщений: send-message. Описание должно быть кратким и состоять из двух слов, разделенных дефисом -.

4. разработчик

Рекомендуется указывать имя разработчика, например: engine.li

Пример:

feature_20220915_send-message_engine.li

Как обновлять код после форка и синхронизировать его с исходным кодом

# Выбор исходного репозитория
git remote add upstream https://github.com/twbs/bootstrap.git
# Обновление форкнутого кода
git fetch upstream
git checkout master
git merge upstream/master
# Применение обновлений к своему форкнутому коду
git push origin master