Contributing to AI Readiness

AI Readiness is Apache 2.0 licensed and accepts contributions via git pull requests. Each commit must include a DCO line in the git commit message:

Signed-off-by: GitHub User Name <your.email@example.com>

This sign-off means you agree the commit satisfies the Developer Certificate of Origin (DCO).

Contributing Issues

Have you searched for duplicates? A simple search for exception error messages or a summary of the unexpected behaviour should suffice.
Are you running the latest version?
Are you sure this is a bug or missing capability?

Create your issue here.
New issues contain two templates in the description: bug report and enhancement request. Please pick the most appropriate for your issue, then delete the other.
- Please also tag the new issue with either "Bug" or "Enhancement".
Please use Markdown formatting liberally to assist in readability.
- Code fences for exception stack traces and log entries, for example, massively improve readability.

To make review of PRs easier, please:

Please make sure your PRs will merge cleanly - PRs that don't are unlikely to be accepted.
For code contributions, follow the existing code layout.
For documentation contributions, follow the general structure, language, and tone of the existing docs.
Keep commits small and cohesive - if you have multiple contributions, please submit them as independent commits (and ideally as independent PRs too).
Reference issues if your PR has anything to do with an issue (even if it doesn't address it).
Minimise non-functional changes (e.g. whitespace).
Ensure all new files include a header comment block containing the Apache License v2.0 and your copyright information.
If necessary (e.g. due to 3rd party dependency licensing requirements), update the NOTICE file with any new attribution or other notices