-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmake_my_code_better.txt
More file actions
24 lines (24 loc) · 1.76 KB
/
Copy pathmake_my_code_better.txt
File metadata and controls
24 lines (24 loc) · 1.76 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
1) Жёсткие нарушения PEP8
Просто, давайте следовать требованиям PEP8
2) Нейминг
Именование - это важно, правильно называй переменные: прочитал название - понял что делает функция или переменная
3) Комментарии
Комментарии не должны пояснять что делает код, а зачем этот код написан
4) Документация по проекту
Точнее её отсутствие ;)
5) Бизнес-логика в контроллерах
Работа с БД или слишком большая view'шка - значит бизнес-логика
6) Использование функций
Функции не должны быть слишком длинными
7) Изучите ваш фреймворк
прежде чем делать это самому - посмотри не сделано ли это в твоём фреймворке
8) Исключения и обработка ошибок
нет обработки - плохо
9) Логирование
нет логирования - плохо
10) Конфиденциальные данные в коде и git репозиториях
Не вставляй API ключи в код! Не храни ключи в репозитории, ключи - в переменных окружения
11) pip requirements и состав git репозитория
Нет файла где описаные все пакеты которые нужно установить для проекта
12) Преждевременные попытки внедрить паттерны
Не усложняй, keep it stupid simple!