Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
106 lines (75 loc) · 4 KB

CONTRIBUTING.md

File metadata and controls

106 lines (75 loc) · 4 KB

Правила участия в проекте (Git Flow)

Спасибо за интерес к участию в нашем проекте! Данный документ описывает процесс разработки с использованием Git Flow.

Git Flow Модель

Проект использует Git Flow для организации разработки. Основные ветви:

  • main - продакшн версия, релизы
  • develop - интеграционная ветка для разработки

Процесс разработки

1. Новая функция (Feature)

# Создайте ветку для новой функции из ветки develop
git checkout -b feature-name develop

# Разрабатывайте функцию
git commit -m "Описание изменений"

# Отправьте ветку на сервер
git push origin feature-name

# Создайте Pull Request в develop
# Описание PR должно включать:
# - Что было сделано
# - Почему это необходимо
# - Как это тестировать

2. Исправление ошибок (Bugfix)

# Создайте ветку для исправления ошибки из develop
git checkout -b bugfix/описание-ошибки develop

# Исправьте ошибку
git commit -m "Исправление: описание"

# Отправьте на сервер и создайте PR в develop
git push origin bugfix/описание-ошибки

Соглашения по коммитам

Используйте следующий формат коммитов:

<тип>: <описание>

<подробное описание (опционально)>

Типы коммитов:

  • feat - новая функция
  • fix - исправление ошибки
  • docs - обновление документации
  • style - изменения форматирования (пробелы, точки с запятой и т.д.)
  • refactor - рефакторинг кода
  • perf - улучшение производительности
  • test - добавление тестов
  • chore - изменения build скрипта, зависимостей и т.д.

Примеры:

feat: добавлена поддержка нового типа документов
fix: исправлена ошибка при парсинге PDF
docs: обновлена документация по установке

Требования к Pull Request

  1. Название PR должно быть описательным

  2. Описание должно содержать:

    • Описание изменений
    • Причина изменений
    • Инструкции по тестированию
    • Скриншоты (если применимо)

  3. Код должен быть:

    • Протестирован локально
    • Следовать стилю проекта
    • Содержать комментарии для сложных участков

  4. Перед слиянием:

    • Минимум 1 одобрение от мейнтейнера
    • Все проверки должны пройти успешно
    • Нет конфликтов с целевой веткой

Стиль кода

  • Используйте Python 3.12+
  • Следуйте PEP 8
  • Добавляйте type hints где возможно
  • Пишите понятные имена переменных и функций
  • Добавляйте docstring для функций и классов

Вопросы и предложения

Если у вас есть вопросы или предложения по улучшению процесса, создайте Issue или свяжитесь с мейнтейнерами проекта.

Спасибо за вклад в развитие проекта!