If you want to help develop PyTestArch, please read the following guide on setting up the development environment and on which requirements need to be fulfilled for a PR to be ready for approval.
Poetry is used for dependency and packaging management. Install poetry if you haven't already.
Run poetry install to create a virtual environment with the required dependencies.
There are also git hooks for ruff and mypy available via pre-commit install.
To make sure that everything works as expected, run nox.
When opening a PR, make sure the following requirements are fulfilled:
- All existing tests should pass: Run
noxto ensure this. Github Actions will be used to run all tests with multiple python versions, so this is just meant for local use without having to open a PR first. - Ensure your code is properly formatted. Make sure you are using the pre-commit hooks to ensure this.
- For new features or bugfixes, your added code should be covered by new tests.
- Add your changes to the changelog.
- Update existing doc strings and documentation.
- Add doc strings for newly added public functions and methods.
- Add doc strings for complicated "private" functions and methods.
- Add high level documentation for new features.