Инструкция для разработчиков
Инструкция по внесению изменений в проект
- Выберите существующую задачу или заведите новую на нашем Github для фичи, которую вы хотите доработать.
- Форкните проект на Github. Необходимо создать отдельную ветку для работы над форком. Это позволит отправить доработки на Pull request в основной проект Kaspresso.
- Сделайте необходимые дорабтки в исходном коде.
- Покройте новые доработки необходимыми тестами, которые проверят стабильность и соответствие ожидаемому поведению написанного кода, или исправьте существующие тесты на этот функционал.
- Запустите все Unit и UI тесты и убедитесь в их успешном прохождении.
- Запустите проверку покрытия кода Unit-тестами, чтобы убедиться, что для нового кода были написаны Unit-тесты.
- После завершения разработки подготовьте commit с соответствующим и понятным комментарием и номером issue (задачи из списка).
- Создайте pull request и дождитесь, пока другие участники посмотрят изменения.Необходимо принять соглашения CLA.
- После получения подтверждения от других участников, можно вливать дорабтки в основной код. Обновленный код будет доступен пользователям в следующем релизе, а ваше имя будет добавлено в список авторов.
Именование веток
issue-***/detailed_description. Пример: issue-306/fix-padding-breaks-autoscroll-interceptor
Коммиты
Сообщения к коммитам должны начинаться с: "Issue #***: ...". Пример: "Issue #306: Fixed padding-breaks autoscroll interceptor".