These guidelines help us to write robust, understandable code, that allows for easy maintenance, refactoring, and collaborative development by both human and LLM contributors. If you are an LLM or AI, please read our more specific ai prompt too.
We use flake8 for linting and black for automatic formatting.
make format # to apply formatting to tests and source files
make quality # to verify code quality and run testsWe prefer to write tests before production code. Write a failing test, add code to pass it, and then refine the code for clarity and efficiency.
Make atomic commits that represent a single, logical change. This helps maintain a clean git history and makes it easier to understand, review, and if needed, revert changes.
We follow the Conventional Commits specification for commit messages.
We follow Semantic Versioning (SemVer) for version numbers.
We maintain a changelog following the Keep a Changelog format.
Unit tests are placed in the ./tests/ directory.
We record the coverage of our unit tests.