Developer guide

Pre-commit

Pre-commit is a framework for managing and maintaining multi-language pre-commit hooks. Pre-commit hooks are scripts that run automatically before each commit, ensuring code quality by catching errors and enforcing standards.

Install Pre-commit:

$ pip install pre-commit
$ pre-commit install

The main function of our pre-commit is to utilise the ruff linter and formatting checker. A single tool that takes the combined role of tools like isort, pycodestyle, black and flake8 (including many more).

Testing

Running test discovery using pytest:

$ pytest

Continuous integration (CI)

DAGrunner utilises github actions workflows to ensure the following is done when a change is proposed (PR):

• Ensure tests are run and successfully complete without issue.
• Reference documentation is automatically built and committed to the developers branch.
• pre-commit is executed on all files.