Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (34 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

55 lines (34 loc) · 1.79 KB

Contributing Guide

Мы приветствуем любую помощь в развитии проекта. Чтобы процесс был эффективным, следуйте этим простым правилам.

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

  1. Fork & Clone — сделайте форк репозитория и склонируйте его себе.
  2. Feature Branch — создайте новую ветку для своей задачи:
    git checkout -b feature/amazing-feature
  1. Commit — делайте понятные коммиты. Придерживайтесь стиля Conventional Commits.
  2. Push — отправьте ветку в свой форк:
git push origin feature/amazing-feature
  1. Pull Request — откройте PR в ветку main.

Markdown

Требования к коду

  • Скрипты: Все .sh файлы должны быть в формате LF (Unix) и иметь права на исполнение.
  • Docker: Проверяйте синтаксис compose.yaml перед отправкой:
    docker compose config
  • Документация: Если вы меняете переменные в .env, обязательно обновите .env.example и README.md.

Сообщения об ошибках

Если вы нашли баг, создайте Issue и укажите:

  1. Версию ОС и Docker.
  2. Шаги для воспроизведения.
  3. Ожидаемый и фактический результат.

Стандарты общения

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