-
Notifications
You must be signed in to change notification settings - Fork 4
Контрибьютинг
Michael Hose edited this page Oct 10, 2021
·
1 revision
Старайтесь облегчить чтение и проверку вашего кода, так как любой ревьюер — человек, который может пропустить деталь, не учесть что-то при проектировании, неточно понять задачу.
Сделать PR понятным для остальных помогут:
- Ваши комментарии к PR. Их можно добавить, не дожидаясь появления первых вопросов.
- Комментарии в коде к неочевидным решениям или специальным браузерным хакам. При этом комментариями в коде не следует злоупотреблять. Код должен говорить сам за себя и быть понятным. Следует придерживаться такого правила: если ощущается необходимость что-то прокомментировать внутри метода, этот код лучше выделить в новый метод.
Пункты, на которые стоит обратить внимание при оформлении. Общее:
- Автор задачи выбрал
develop
ветку для PR. - Правильно выбраны типы коммитов: используются
fix/feat/BREAKING CHANGE
– это критично для обновления версий проекта. - Новое решение не противоречит существующим PR.
Код:
- Код написан понятно, имена переменных читаемы, не используются сложные конструкции.
- Код подходит под описание задачи. Не было проведено другой работы не по задаче, которая может повлиять на другие части проекта.
Сборка:
- Сборка прошла успешно (Github Actions)
Join us in Telegram ask us on Github Discussion if you have any questions.