Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (17 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

28 lines (17 loc) · 1.29 KB
Raw

Contributing to aieng-template

Thanks for your interest in contributing to the aieng-template-implementation!

To submit PRs, please fill out the PR template along with the PR. If the PR fixes an issue, don't forget to link the PR to the issue!

Code checks (before opening a PR)

Commits do not run linters automatically. After uv sync --group dev, run the same checks CI uses:

uv run pre-commit run --all-files

Or use make dev lint to sync the dev environment, apply Ruff formatting/import sorting, and run mypy on the aieng package. Fix any failures before submitting a PR — GitHub Actions runs pre-commit run --all-files on pushes and pull requests to main.

Coding guidelines

For code style, we recommend the PEP 8 style guide.

For docstrings we use numpy format.

We use ruff for code formatting and static code analysis. Ruff checks various rules including flake8. Address ruff and mypy feedback from your local run or from CI before merging.

Last but not the least, we use type hints in our code which is then checked using mypy.