Настройка среды разработки

Запускайте проверки для разработки в репозитории изменяемого компонента. Они не связаны со средой, необходимой для запуска симуляции.

В репозитории OpenCDA используется pre-commit, чтобы обеспечить единообразное форматирование и выполнение основных проверок до попадания кода в CI. Выполните следующие команды из корня репозитория OpenCDA, чтобы один раз установить и включить его для клона. После этого хуки будут запускаться автоматически перед каждым коммитом:

python3 -m venv .venv
source .venv/bin/activate
python -m pip install pre-commit
pre-commit install

Запустите все хуки вручную:

pre-commit run --all-files

Полезные команды для повседневной работы:

# Run only Ruff linting and automatic fixes
pre-commit run ruff-check --all-files

# Run only formatting
pre-commit run ruff-format --all-files

Текущий набор хуков включает:

• ruff-check с включёнными автоматическими исправлениями

• ruff-format

• hadolint для Dockerfile

• общие проверки безопасности и качества для YAML, JSON и TOML, а также проверки конфликтов слияния, пробельных символов, символических ссылок и файлов зависимостей

CI также выполняет дополнительные проверки, включая pytest, mypy, deadcode и pre-commit для всего репозитория. Перед созданием pull request запустите локальные хуки, чтобы заранее выявить наиболее распространённые ошибки.

Документация

Описание изолированной среды, строгой сборки, проверки ссылок и локального предпросмотра приведено в README репозитория Documentation.