commit 503a3e81cc9b8bc2f0bd2f8c1eddd93fe521de41
parent 05e4b386ff5555149eee14ce6c117c9313988bf4
Author: Sergej Orlov <wladimirych@gmail.com>
Date: Fri, 30 Nov 2018 15:13:58 +0100
Update PR recommendations: make list ordered
Diffstat:
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,33 +1,33 @@
-* К каждому PR должен быть issue.
+1. К каждому PR должен быть issue.
В issue желательно обсудить что, как и зачем будет сделано,
особенно если это новый issue.
-* Прежде чем делать PR надо протестировать, что код работает,
+2. Прежде чем делать PR надо протестировать, что код работает,
причём в нескольких сценариях.
-* Также надо проверить, что в eslint не появилось новых предупреждений
+3. Также надо проверить, что в eslint не появилось новых предупреждений
в изменнённых частях кода.
-* Коммитов в PR должно быть минимальное количество, как правило один.
-Если в рабочей ветке коммитов больше, надо их сребейзить прежде чем делать PR.
+4. Коммитов в PR должно быть минимальное количество, как правило один.
+Если в рабочей ветке коммитов больше, надо их сребейзить прежде чем делать PR (см. п.10).
-* Все изменения в PR должны относиться только к решаемой задаче.
+5. Все изменения в PR должны относиться только к решаемой задаче.
Например, не надо делать рефакторинг кода,
в который не вносятся функциональные изменения.
-* Если в PR есть слабо связанные изменения, но относящиеся к решаемой задаче,
+6. Если в PR есть слабо связанные изменения, но относящиеся к решаемой задаче,
их надо разделить на несколько коммитов,
например, если изменения можно применить по отдельности
без нарушения валидности кода и функциональности программы.
-* Во всех commit message в первой строке должна быть ссылка на issue (не на PR)
+7. Во всех commit message в первой строке должна быть ссылка на issue (не на PR)
в виде #123
-* Если нужно сделать длиный commit-message, то
+8. Если нужно сделать длиный commit-message, то
в первой строке надо написать краткое описание, оставить одну пустую строку,
затем написать остальной текст.
-* Изменения по ревью можно как делать новыми коммитами, так и добавлять в первый и пушить с форсом.
+9. Изменения по ревью можно как делать новыми коммитами, так и добавлять в первый и пушить с форсом.
-* Перед мержем все коммиты необходимо склеить (кроме случая слабо связанных изменений) и отребейзить на master:
+10. Перед мержем все коммиты необходимо склеить (кроме случая слабо связанных изменений) и отребейзить на master:
https://blog.carbonfive.com/2017/08/28/always-squash-and-rebase-your-git-commits/
