Contributing to this Repo

Pull requests are welcome.

If you will be contributing to this repo, please adhere to all the standards described on this page.

Standards

1. All code should be error-free via flake8 linting.

2. Where applicable, use pytest-compliant unit tests.

3. All code should be thoroughly tested before being checked in.

Continuous Integration (CI)

NEVER merge into the main branch. Instead, merge into the actions branch, and the following will be automatically performed:

1. The code will be tested, and will NOT be merged into main if there are any errors.

2. Documentation will be built and published to the docs branch (which keeps the main branch light).

   (To test documentation ahead of time, run docsrc/build. NEVER check in documentation to your branch.)

3. The version number will be updated, and the repo will be tagged with the version number.

4. All changes will be merged into main.