Contributing

Model Auditor’s source package and this documentation site are maintained in separate repositories.

• Source development setup prepares an editable v0.1.16 checkout.
• Testing and verification describes the stable pytest suite and manual quality gates.
• Releases and documentation synchronization explains PyPI publication and how this site advances to a new stable release.

Use the source issue tracker for package defects and feature requests.

Contribution principles

• Reproduce behavior against a specific source commit.
• Add or update deterministic tests for behavioral changes.
• Preserve the public result hierarchy unless an intentional API change is documented.
• Treat sparse groups, missing values, and categorical placeholders as first-class test cases.
• Keep optional plotting dependencies optional.
• Update documentation when a public signature, default, result shape, error, or edge behavior changes.
• Do not describe unreleased default-branch behavior as stable documentation.

Documentation changes

Before opening a documentation pull request:

1. confirm the source release in Documentation source;
2. put procedures in guides, durable explanations in concepts, and exact contracts in reference;
3. verify every code fence and internal link;
4. run npm run format;
5. run npm run validate;
6. review the Linux pull-request checks; and
7. inspect the Cloudflare preview.

A source-release synchronization must update docs-source.json and all affected pages together.