Спецификации коммитов кода

Предложения по обзору кода

Проект BK-CI включает в общей сложности пять языков: JavaScript, Golang, Kotlin, Java и Lua. По умолчанию мы, команда разработчиков, используем следующие инструменты для обзора кода. Чтобы повысить эффективность слияния, пожалуйста, просмотрите код самостоятельно перед фиксацией.

• ESLint
• Gometalinter
• detekt

Формат коммита

Формат сообщений коммитов в персональной ветке.

type:message issue

• type — информация о типе изменений:
  • feature — новая функция;
  • fix — исправление ошибки;
  • docs — изменение документа;
  • style — форматирование кода, например, пропущенные точки с запятой; без изменений в коде;
  • refactor — рефакторинг кода;
  • test — добавление недостающих тестов, рефакторинг тестов; без изменений в рабочем коде;
  • chore — соответствующий код, такой как скрипты сборки, задачи и т. д.
• message — описание этого коммита;
• issue — идентификатор проблемы, к которой привязан этот коммит.

Рекомендации по запросу на слияние/запрос на вытягивание

Разработчики могут иметь простые сообщения коммитов на своих собственных разветвлённых ветках. Рекомендуется уточнить сообщения коммитов с помощью git rebase перед отправкой запросов на слияние. Пожалуйста, обратитесь к предыдущему разделу для уточнения информации. Для соответствующих команд используйте следующую процедуру.

# Используйте новую ветку для разработки функции
git checkout feature1-pick
# Многократная отладка и коммиты
git commit -m "xxx"
git commit -m "yyy"
git commit -m "zzz"
# Если импортированы новые сторонние зависимости, используйте dep для управления зависимостями 
dep ensure -v -add github.com/org/project

# Операция перебазирования, объединение нескольких изменений (3 раза ниже) в ветке feature1-pick 
# Полная стандартная информация о коммите
git rebase -i HEAD~3

# Отправить в удалённый репозиторий
git push origin feature1-pick:feature1-pick
# Отправить PR/MR и дождаться слияния
#......................
#......................

# После того, как PR/MR будет объединён, синхронизируйте локальную основную ветку
git fetch upstream
git rebase upstream/master