Pull Requests
Здесь можно познакомиться с правилами создания Pull Requests.
Форматирование имён коммитов
Правила по именованию коммитов можно увидеть по ссылке
Мы используем следующие имена диапазонов:
- kb - обновление базы знаний
- solver - обновление решателя задач (C++ и Python агенты)
- client - обновление web-клиента
Можно обновить документацию для добавления новых диапазонов с помощью pull request
Можно и не использовать диапазоны. Например: feat: ..., fix: ...
Каждый коммит не должен иметь больших изменений, они возможны только в случаях:
- Codestyle изменений;
- переименования;
- форматирования кода;
Делайте отдельные коммиты для каждого изменения. Например, Вы изменили имя объектов наClassX и ClassY, тогда нужно два коммита:
fix(<scope>): rename members in ClassX according to codestyle
fix(<scope>): rename members in ClassY according to codestyle
Не смешивайте логические и стилистические изменения в одном коммите
Все коммиты, которые не соответствуют этим правилам, должны быть исправлены. Иначе Ваш Pull request не будет принят.
Подготовка Pull Request
При необходимости:
- Ознакомьтесь с документацией по созданию PR
- Обновите changelog
- Обновите документацию
Создание Pull Request
- Создайте PR в GitHub
- Убедитесь, что CI прошёл успешно
- Укажите, кто проверяет PR (Reviewers)
- Отправьте ссылку на PR в чат разработки проекта
Проверка Pull Request
- Проверяющий должен проверить код из PR
- Проверяющий отправляет отзыв на PR (одобрение, комментарий или запрос изменений)
- Автор PR вносит исправления в коммиты
Review fixes - Автор PR повторно ждет проверки
- Если все исправлено в PR, то проверяющий одобряет PR
После проверки Pull Request
- Автор может обновить историю коммитов для удаления
Review fixes - Автор проверяет проект со своими изменениями
- Автор мержит PR в главную ветку