Skip to content

Commit

Permalink
Merge pull request #5 from nifadyev/feature/add-rule-template
Browse files Browse the repository at this point in the history
Add rule/recommendation template
  • Loading branch information
soltanoff authored Sep 19, 2024
2 parents 4975114 + 036fe8a commit adc5ac8
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
21 changes: 21 additions & 0 deletions EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

Expand Down
20 changes: 20 additions & 0 deletions RU.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@


## Содержание
- [Шаблон правила](#шаблон-правила)
- [Про код](#про-код)
- [Основные принципы](#основные-принципы)
- [Атомарность операций](#атомарность-операций)
Expand All @@ -25,6 +26,25 @@
- [Прочее](#прочее)
- [Документация к REST API](#документация-к-rest-api)

## Шаблон правила

Опишите правило или рекомендацию, сопроводив ее необходимыми нюансами и контекстом. По возможности предоставьте примеры нарушения и соблюдения правила в блоках `Плохо` и `Хорошо`. Комментарии к фрагментам кода приветствуются.

Плохо ❌:

```python
# Фрагмент кода с нарушением правила
```

Хорошо ✅:

```python
# Фрагмент кода с соблюдением правила
```

**Почему?**

Обязательная секция с аргументами и причинами использования правила. Желательно указать ссылки на issues/статьи/stackoverflow в поддержку аргументов.

## Про код

Expand Down

0 comments on commit adc5ac8

Please sign in to comment.