- Скачать репозиторий (через
git clone
или PyCharm) - Перейти в папку, куда склонирован репозиторий
- Инициализировать субмодули (
git submodule init
иgit submodule update
) - Временно сменить ветку на
prod
, далее см. Раздел про командную работу - Настроить виртуальное окружение или глобальный интерпретатор python. Используется python 3.11
- Установить все библиотеки через
pip install -r requirements.txt
- Ознакомиться с инфой по линтерам
- Включить гит-хуки:
pre-commit install
- Пометить папку
xieffect
как Sources Root - Пометить папку
xieffect/test
как Test Sources Root - Стоит в меню "commit" нажать на шестерёнку под полем ввода и включить:
- Reformat Code
- Analyze Code
- Несколько инструкций добавлено с линтерами
- Перейти в папку
xieffect
- Запустить
wsgi.py
(через командуpython wsgi.py
или через одноимённую run-конфигурацию) - Проверить доступность http://localhost:5000/doc/ и остановить сервер
- В папке
xieffect
запуститьpytest
(через консоль одноимённой командой или через run-конфигурацию) - Дождаться успешного завершения тестов
- Никогда не работать в ветках
master
илиprod
- Создавать ответвления (feature-branches) от
prod
для работы над проектом - По окончании работы над фичей, отправлять PR из своей feature-branch в
prod
- В PR нужно призывать кого-то на review (обычно reviewer определяется при взятии таски)
- Если во время работы над фичей произошло обновление в
prod
, необходимо ребейснуть собственную ветку наprod
(важно уметь это делать — лучше спросить, чем сломать git) - За merge PR-а отвечает лид или старший разработчик (в будущем...)
- При чекауте иногда нужно прогонять
git submodule update
и переустанавливать зависимости
# с активированным venv или через `python -m`
pip freeze > tmp
pip uninstall -y -r tmp
rm tmp
pip install -r requirements.txt
TBA