Skip to content

Latest commit

 

History

History
87 lines (61 loc) · 3.79 KB

CONTRIBUTING.md

File metadata and controls

87 lines (61 loc) · 3.79 KB

📚 Руководство по вкладу (Contributing Guide)

Спасибо, что решили внести вклад в этот проект! Мы ценим каждую помощь, будь то исправление опечаток, улучшение документации, добавление новой функциональности или сообщение об ошибке.

🛠️ Как внести вклад

  1. Сделайте Fork репозитория.
  2. Создайте новую ветку:
    git checkout -b feature/ваша-фича или git checkout -b fix/ваше-исправление
  3. Внесите изменения.
  4. Проверьте, что все тесты проходят:
    pytest, npm test, или другая команда (уточняется в README).
  5. Сделайте коммит (см. формат ниже).
  6. Отправьте ветку:
    git push origin feature/ваша-фича
  7. Создайте Pull Request на GitHub и опишите:
    • Что изменено
    • Почему это важно
    • Ссылки на связанные issue, если есть

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

  • Код должен быть чистым, читаемым и отформатированным согласно стандартам проекта.
  • Все существующие и новые тесты должны проходить.
  • Название и описание PR должны быть понятными.
  • Если меняется интерфейс (UI), добавьте скриншоты.

✍️ Формат сообщений коммитов

Используем Conventional Commits:

тип(область): краткое описание

[дополнительное описание]
[ссылки на issue, задачи и т.п.]

Примеры:

  • feat(auth): добавлена двухфакторная аутентификация
  • fix(api): исправлена ошибка 500 при обновлении профиля
  • docs(readme): обновлена инструкция по установке
  • refactor(ui): оптимизирована структура компонентов

Популярные типы:

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

🤝 Кодекс поведения

Мы придерживаемся Contributor Covenant как нашего кодекса поведения.

  • Будьте вежливы и уважительны.
  • Избегайте токсичного поведения.
  • Уважайте чужое время и труд.

📬 Сообщения об ошибках и предложения

Если вы нашли баг или хотите предложить улучшение:

  1. Создайте issue с понятным заголовком.
  2. Опишите:
    • шаги воспроизведения (для багов)
    • что вы ожидаете
    • скриншоты, если нужно

📄 Лицензия

Все вклады принимаются в соответствии с лицензией проекта (см. LICENSE).