Contributing

One goal with this project is that we remain focused on the behaviors we want the product to produce. Nearly all other concerns should be able to be codified in things like the .pre-commit-config.yml file, the .github/workflows files, the .gitignore file, and the pyproject.toml file.

As such, we are leveraging Behavior Driven Development, and more specifically, the gherkin syntax for specifying behavior in an executable fashion using Given/When/Then statements. These statements are captured in plaintext, in feature files are in the features directory, and the tests that implement those features are in the tests directory. You can find more detail on this in the testing section.

Guidelines

  1. Install Precommit and remain compliant with that ruleset

  2. Install and use the uv tool to run the various commands

  3. Ensure we maintain code coverage

    1. This is enforced by the coverage requirement embedded in the pytest github workflow.

    2. If you are writing code that is not covered by the existing tests, either

      1. add a new test

      2. consider if the code you are writing is necessary, as the existing tests cover existing requirements.

  4. Ensure your code is well documented

    1. this is enforced can be done via the interrogate tool, which is run as part of the precommit checks

  5. Update the project version number.

    1. This is done in the pyproject.toml file, and should follow semantic versioning principles.

  6. Open pull requests against the main branch

    1. Ensure your PR passes all checks

    2. Ensure your PR is reviewed and approved by at least one other person

    3. Ensure your PR is merged using the “Squash and Merge” option, to ensure a clean commit history

For more details on what precommit checks are run, see the .pre-commit-config.yaml file.

Developer Signoff

By contributing code to this project, you agree to the following:

  1. You have the right to submit the code you are contributing, and it does not violate any third party rights.

  2. You agree to license your contributions under the MIT License.

  3. You agree to the Developer Certificate of Origin (DCO) as described in the DCO 1.1.

If you do not agree to these terms, please do not contribute code to this project. The DCO is enforced via a pre-commit hook.

Contents: