Skip to content

Регламенты кодирования

Kirill Kovalets edited this page May 2, 2023 · 3 revisions

Коммиты

  1. Текст на русском.
  2. Стиль: <Действие> : <текст коммита>.
  3. Максимальная длина – 50 символов.

Ветвление

  1. Отдельная ветка под каждый issue. Формат: feature/<номер issue>.
  2. По завершении работа создается pull request в ветку develop, в сопровождающем сообщении указывается соответствующий issue, ветка удаляется.
  3. По достижению Milestone создаётся pull request из ветки develop в ветку master.

Оформление исходного кода

  1. Верблюжий стиль для названий переменных, функций и т.д.
  2. Использование линтера Flake8, который позволяет просканировать код проекта и обнаружить в нем стилистические ошибки и нарушения различных конвенций кода на Python.