Help developing

Local set-up

Please install pre-commit, for example through Conda. For more information, see Help developing on compwa.github.io.

It is assumed that repositories that use shared workflows from this repository can run their CI jobs locally with tox. Names of the workflow files should therefore be the same as the name of the corresponding tox job. For example, a common job is docnb, which builds HTML pages with Sphinx using the myst-nb extension. The corresponding job file for this job is docnb.yml.
Workflow definitions are located under .github/workflows: GitHub Actions does not yet support sharing workflows in subdirectories.
Actions are located under directories in the root folder, for example pip-install/action.yml.