Contributing¶

If you would like to contribute to CabanaPD, please open a pull request with main as the destination branch on the repository and allow edits from maintainers in the pull request.

Your pull request must pass tests, which includes using the coding style from .clang-format (enforced with clang-format-14), and be reviewed by at least one CabanaPD developer. Formatting can be applied with make format within the build folder.

pre-commit is a useful tool for ensuring feature branches are ready for review by running automatic checks locally before a commit is made. Installation details (once per system) and activation details (once per repo) are available.

Documentation¶

The documentation consists of markdown files in the docs directory and can be built with zensical. They also provide instructions on how to install zensical and build the website locally while writing.

In most instances, pip install zensical (once per system) and zensical serve from the CabanaPD base folder is all that is needed to get a link to live-edit the site locally.