Codestyle - FrBrGeorge/HWorker GitHub Wiki
Дисциплины
ВНИМАНИЕ! Не увлекаться! Полиси нужно только для удобства работы, и больше ни для чего.
Оформление исходного текста
- Стиль
- Используем относительный
import - За формат отвечает black
- Длина строки 120
- Используем относительный
- Аннотации
Настройка pycharm для работы с black
Settings -> Tools -> Black
- On code reformat
- On save
Settings: -l 120
Ведение разработки
- Тестирование
- Документирование API
- Зависимости в
Pipfile- Эксплуатационные —
[packages] - Сборочные (включая pylint и pytest —
[dev-packages] - Инструментальные (типа PyCharm) — нигде
- Должно работать в
Pipenv
- Эксплуатационные —
Коммиты и pull request-ы
- Центральный репозиторий READ-only для всех, кроме @FrBrGeorge
- Все изменения оформляются в виде pull request
- Коммит-сообщения — как в лекции
- Одно изменение — один коммит
- В сообщении описывается решаемая задача, а не проделанные действия (хотя иногда это одно и то же)
- Если задача составная, используем многострочный формат (Однострочное summary, пустая строка, многострочное пояснение)