Skip to content

Commit 51e76e9

Browse files
authored
Added information about pre-commit
1 parent 2393544 commit 51e76e9

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Evrone Python Codestyle
22

3+
## Основные принципы при написании кода
4+
- **Поддерживаемость** (представьте, сможете ли вы понять свой код через год или через два)
5+
- **Простота** (между сложным и простым решением следует выбрать простое)
6+
- **Очевидность** (представьте, когда подключится новый программист, насколько ему будет понятно, почему именно **так** написан этот код)
7+
38

49
## Пакетный менеджер
510

@@ -51,6 +56,34 @@ src_paths = "app"
5156
```
5257

5358

59+
## Pre-commit хуки
60+
61+
[pre-commit](https://pre-commit.com) - фреймворк для управления `pre-commit` хуками
62+
63+
Рекомендуемый конфиг `.pre-commit-config.yaml`:
64+
65+
```yaml
66+
default_language_version:
67+
python: python3.8
68+
69+
repos:
70+
- repo: local
71+
hooks:
72+
- id: black
73+
name: black
74+
entry: black app
75+
language: python
76+
exclude: models
77+
types: [python]
78+
79+
- id: isort
80+
name: isort
81+
entry: isort app
82+
language: python
83+
types: [python]
84+
```
85+
86+
5487
## Типизация
5588
5689
[mypy](http://mypy.readthedocs.io) - чекер для статической типизации

0 commit comments

Comments
 (0)