๐Ÿ› ๏ธ Contributing to AICertify ๐Ÿš€

April 6, 2025 ยท View on GitHub

Thank you for your interest in contributing to AICertify! ๐ŸŽ‰ We welcome contributions from developers, AI practitioners, and governance professionals.

๐Ÿ“Œ Ways to Contribute

1๏ธโƒฃ Reporting Issues

  • Found a bug or incorrect validation? Open a GitHub Issue.
  • Before posting, search existing issues to avoid duplicates.

2๏ธโƒฃ Feature Requests & Discussions

  • Have an idea for improvement? Start a discussion! ๐Ÿ‘‰ Join GitHub Discussions
  • If it's a major proposal, we recommend creating an issue first.

3๏ธโƒฃ Contributing Code

We accept bug fixes, new policies, API improvements, and documentation updates.

๐Ÿ“œ Setting Up Your Development Environment

  1. Fork the Repository & Clone:

    git clone https://github.com/mantric/AICertify.git
    cd AICertify
    
  2. Install Dependencies:

    pip install -r requirements.txt
    
  3. Run Tests Before Pushing:

    python cli.py --category compliance/eu_ai_act --input examples/input_examples.json
    
  4. Create a Feature Branch:

    git checkout -b feature-new-policy
    
  5. Commit & Push Your Changes:

    git commit -m "Added new AI fairness policy"
    git push origin feature-new-policy
    
  6. Create a Pull Request (PR):

    • Title: Be concise but descriptive.
    • Description: Explain why this PR improves AICertify.
    • Check CI Logs: Ensure tests pass before requesting a review.

4๏ธโƒฃ Writing OPA Policies

We encourage contributions to regulatory compliance, functional validation, and acceptance criteria.

๐Ÿ“ Example Contribution: New OPA Policy

๐Ÿ“„ policies/compliance/new_policy.rego

package compliance.custom_policy

default allow = false

allow {
    input.some_metric < 0.1
}

Add an example input file in examples/, update README.md, and test it.


๐Ÿ“œ Code of Conduct

By contributing, you agree to follow our Code of Conduct (to be added soon).

โœ… Contribution Checklist

โ˜‘ Code follows project conventions. โ˜‘ New policies include test cases in examples/. โ˜‘ No breaking changes without discussion. โ˜‘ All contributions follow semantic commit messages.

๐Ÿท๏ธ Issue & PR Labels

We use GitHub Labels to track work:

  • ๐Ÿž bug โ†’ Report issues.
  • ๐Ÿš€ enhancement โ†’ New features.
  • ๐ŸŽฏ validation โ†’ AI correctness checks.
  • ๐Ÿ“œ compliance โ†’ AI governance & policies.
  • ๐Ÿ“ documentation โ†’ Docs, examples, & guides.

๐Ÿ‘‰ See all labels here.

๐Ÿš€ Thank you for making AI governance better with AICertify! ๐ŸŽ‰