Contributing 🤝

Спасибо за интерес к проекту!

Перед созданием Pull Request ознакомьтесь с правилами ниже. Они помогают поддерживать единый стиль разработки, упрощают ревью и сохраняют историю изменений понятной.

1. Workflow

Все изменения вносятся только через Pull Request.

Перед началом работы:

• убедитесь, что для задачи уже существует Issue;
• если Issue отсутствует — создайте новую;
• один Pull Request должен решать только одну задачу.

Именование веток

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

• feature — новая функциональность;
• fix — исправление ошибок;
• refactor — изменение внутренней реализации;
• docs — изменения документации;
• chore — технические изменения и обслуживание проекта.

2. Commit Convention

Проект использует спецификацию Conventional Commits.

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

<type>(<scope>): <description>

Используйте scope, отражающий затронутую часть проекта.

Поддерживаемые типы:

• feat
• fix
• refactor
• docs
• test
• chore

Примеры:

feat(auth): add jwt authentication
fix(player): prevent duplicate spawn
refactor(movement): extract path validator
docs(contributing): update contribution guide
chore(deps): update dependencies

3. Стандарты разработки

При разработке придерживайтесь следующих принципов:

• соблюдайте существующую архитектуру проекта;
• не добавляйте зависимости без необходимости;
• не смешивайте несколько задач в одном Pull Request;
• разбивайте изменения на небольшие логически завершённые коммиты.

4. Pull Request

Перед открытием Pull Request убедитесь, что:

• проект успешно собирается;
• линтер проходит без ошибок;
• изменения относятся только к одной задаче;
• отсутствуют несвязанные изменения.

Pull Request может быть отклонён, если одно из требований выше не выполнено.

5. Задачи

С планами и текущими задачами можно ознакомиться на доске проекта.