Участие в разработке
Оформление коммитов
Соблюдайте соглашение Conventional Commits:
<type>(<scope>): <краткое описание>
[дополнительное описание]
[footer]
Наиболее популярные типы:
feat— новая функциональность;fix— исправление ошибок;docs— изменение документации;refactor— правка кода без изменения поведения;chore— обслуживание, обновления зависимостей.
Пример:
feat(auth): добавить поддержку OAuth2
Форматирование и линтинг
Перед отправкой коммита выполните проверки:
npm run format # форматирование фронтенда и документации
npm run format:backend # форматирование Python-кода
npm run lint # линтинг и проверка типов
Именование веток
Используйте осмысленные имена веток:
feature/<краткое-описание>— новые возможности;fix/<issue>-<краткое-описание>— исправления;docs/<краткое-описание>— документация.
Создавайте ветки от актуального main.
Описание Pull Request
В описании PR указывайте:
- цель изменения и краткое резюме;
- связанные задачи или issues;
- перечень выполненных проверок (например,
npm run lint); - при необходимости скриншоты или шаги для тестирования.
Четкое описание облегчает ревью и ускоряет включение изменений в проект.