kvn - АПИ для моб приложение, в качесте архитектуры заюзан DRF
-
Строго следуем PEP8 (исключение - длина строки кода, используем 120 символов)
-
Именование переменных, классов, модулей должно быть на латинице, на английском языке.
- Комментарии к коду пишутся на русском языке.
- Комментарии должны быть написано грамотно. без ошибка и со знаками препинания, чтобы текст не мог быть понят неоднозначно.
- Любые комментарии, как призыв к рефакторингу или исправлению бага должны быть написаны, как "TODO"
- Каждый класс должен иметь краткое описание его предназначения
- Поля модели должны иметь
verbose_name
в виде i18n строки на русском языке - Поля с неочевидным названием или имеющими важные примечания обязательно должны иметь
help_text
i18n строки - Параметры полей стараемся писать в одну строку, если параметров много, переносим второй строкой.
- Не забываем о наследовании, если есть множество классов имеющих одни и те же поля, выносим их в абстрактный класс и наследуем его в нужных классах.
- Если у нас есть некий свой тип поля, или сильно кастомизированное имеющиеся, не стесняемся создать из него отдельное поле, чтобы модели не обрастали полями с кучей параметров.
- Если у нас в коде часто встречаются однотипные фильтры, используем менеджер модели, создав в нем нужный метод.
- Перед коммитом, если вы много "игрались" со структурой модели и наплодили несколько миграций для одной модели, чистим их и делаем одну новую.
- Любые зависимости должны иметь указания версий, допустимых к использованию (протестированных)