Skip to content

Commit 156fe60

Browse files
author
Artem Innokentiev
committed
Added table of contents
1 parent 6c3d2c3 commit 156fe60

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

EN.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
# Evrone Python Guidelines
22

33
## Table of Contents
4-
- [About the code](#про-код)
5-
- [Основные принципы](#основные-принципы)
6-
- [Атомарность операций](#атомарность-операций)
7-
- [Логические блоки](#логические-блоки)
8-
- [Размеры методов, функций и модулей](#размеры-методов-функций-и-модулей)
9-
- [Импорты](#импорты)
10-
- [Файлы `__init__.py`](#файлы-__init__py)
11-
- [Докстринги](#докстринги)
12-
- [Про Pull Request](#про-pull-request)
13-
- [Создание Pull Request](#создание-pull-request)
14-
- [Рефакторинг и Pull Request](#рефакторинг-и-pull-request)
15-
- [Размер Pull Request](#размер-pull-request)
16-
- [Про тулинг](#про-тулинг)
17-
- [Тестирование (pytest)](#тестирование-pytest)
18-
- [Пакетный менеджер (poetry)](#пакетный-менеджер-poetry)
19-
- [Форматирование кода (Black)](#форматирование-кода-black)
20-
- [Форматирование импортов (isort)](#форматирование-импортов-isort)
21-
- [Линтер (flake8)](#линтер-flake8)
22-
- [Тайп-чекер (mypy)](#тайп-чекер-mypy)
23-
- [Pre-commit хуки (pre-commit)](#pre-commit-хуки-pre-commit)
24-
- [Прочее](#прочее)
25-
- [Документация к REST API](#документация-к-rest-api)
4+
- [About the code](#about-the-code)
5+
- [Basic principles](#basic-principles)
6+
- [Atomicity of operations](#atomicity-of-operations)
7+
- [Logical blocks](#logical-blocks)
8+
- [Sizes of methods, functions, and modules](#sizes-of-methods-functions-and-modules)
9+
- [Imports](#imports)
10+
- [Files `__init__.py`](#files-__init__py)
11+
- [Docstrings](#docstrings)
12+
- [About Pull Request](#about-pull-request)
13+
- [Creating Pull Request](#creating-pull-request)
14+
- [Refactoring and Pull Requests](#Refactoring-and-pull-request)
15+
- [Pull Request Size](#pull-request-size)
16+
- [About tooling](#about-tooling)
17+
- [Testing (pytest)](#Testing-pytest)
18+
- [Package manager (poetry)](#package-manager-poetry)
19+
- [Code formatting (Black)](#code-formatting-black)
20+
- [Imports formatting (isort)](#imports-formatting-isort)
21+
- [Linter (flake8)](#linter-flake8)
22+
- [Type checker (mypy)](#type checker-mypy)
23+
- [Pre-commit hooks (pre-commit)](#pre-commit-hooks-pre-commit)
24+
- [Other](#other)
25+
- [REST API Documentation](#rest-api-documentation)
2626

2727

2828
## About the code
@@ -188,6 +188,7 @@ One Pull Request must solve exactly one issue.
188188

189189
**Why?** Because it is more difficult for a reviewer to keep the context of several tasks in their head and switch between them. When a PR contains several issues, then the PR often increases and requires more time and effort for the review from the reviewer.
190190

191+
191192
### Refactoring and Pull Requests
192193
Refactoring is best done in a separate Pull Request.
193194

0 commit comments

Comments
 (0)