Merge pull request #5 from nifadyev/feature/add-rule-template

Add rule/recommendation template

Author: soltanoff

EN.md

@@ -3,6 +3,7 @@
 
 ## Table of Contents
 - [About the code](#about-the-code)
+  - [Rule template](#rule-template)
   - [Basic principles](#basic-principles)
   - [Atomicity of operations](#atomicity-of-operations)
   - [Logical blocks](#logical-blocks)
@@ -25,6 +26,26 @@
 - [Other](#other)
   - [REST API Documentation](#rest-api-documentation)
 
+## Rule template
+
+Describe the rule with necessary details and context. Provide `bad`, `good` with examples if possible. Helpful comments to snippets are highly appreciated.
+
+Bad ❌:
+
+```python
+# snippet with bad example
+```
+
+Good ✅:
+
+```python
+# snippet with good example
+```
+
+**Why?**
+
+Section is required and should contain reasons and arguments. It is recommended to provide links issues/resources/stackoveflow for specified reasons and arguments.
+
 
 ## About the code
 

RU.md

@@ -2,6 +2,7 @@
 
 
 ## Содержание
+- [Шаблон правила](#шаблон-правила)
 - [Про код](#про-код)
   - [Основные принципы](#основные-принципы)
   - [Атомарность операций](#атомарность-операций)
@@ -25,6 +26,25 @@
 - [Прочее](#прочее)
   - [Документация к REST API](#документация-к-rest-api)
 
+## Шаблон правила
+
+Опишите правило или рекомендацию, сопроводив ее необходимыми нюансами и контекстом. По возможности предоставьте примеры нарушения и соблюдения правила в блоках `Плохо` и `Хорошо`. Комментарии к фрагментам кода приветствуются.
+
+Плохо ❌:
+
+```python
+# Фрагмент кода с нарушением правила
+```
+
+Хорошо ✅:
+
+```python
+# Фрагмент кода с соблюдением правила
+```
+
+**Почему?**
+
+Обязательная секция с аргументами и причинами использования правила. Желательно указать ссылки на issues/статьи/stackoverflow в поддержку аргументов.
 
 ## Про код