commit db27ff013bd9d481430182ba9b56f017ecbe380d
parent c24a60f41b0354dd1fed17929b6c574b2d6bbafe
Author: Sergej Orlov <wladimirych@gmail.com>
Date: Wed, 28 Nov 2018 22:52:10 +0100
add PR recommendations
Diffstat:
1 file changed, 33 insertions(+), 0 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,33 @@
+* К каждому PR должен быть issue.
+В issue желательно обсудить что, как и зачем будет сделано,
+особенно если это новый issue.
+
+* Прежде чем делать PR надо протестировать, что код работает,
+причём в нескольких сценариях.
+
+* Также надо проверить, что в eslint не появилось новых предупреждений
+в изменнённых частях кода.
+
+* Коммитов в PR должно быть минимальное количество, как правило один.
+Если в рабочей ветке коммитов больше, надо их сребейзить прежде чем делать PR.
+
+* Все изменения в PR должны относиться только к решаемой задаче.
+Например, не надо делать рефакторинг кода,
+в который не вносятся функциональные изменения.
+
+* Если в PR есть слабо связанные изменения, но относящиеся к решаемой задаче,
+их надо разделить на несколько коммитов,
+например, если изменения можно применить по отдельности
+без нарушения валидности кода и функциональности программы.
+
+* Во всех commit message в первой строке должна быть ссылка на issue (не на PR)
+в виде #123
+
+* Если нужно сделать длиный commit-message, то
+в первой строке надо написать краткое описание, оставить одну пустую строку,
+затем написать остальной текст.
+
+* Изменения по ревью желательно делать не новыми коммитами,
+а добавлять в первый и пушить с форсом.
+В любом случаем перед мержем все коммиты необходимо склеить
+(кроме случая слабо связанных изменений).
