Contributing

Community contributions come through GitHub issues and pull requests. Each role and audit repository carries a CONTRIBUTING.md with the full rules; the main points are:

• Issues are open to everyone. Include the branch you are on, your Ansible version, the control affected, and the actual against the expected behavior.

• Pull requests come from approved contributors. To become one, join the Discord server and ask in the community channel, saying what you would like to work on. A maintainer will confirm no one is already working on it and walk you through the conventions.

• Every commit must be GPG signed and carry a Signed-off-by line (git commit -S -s).

• Pull requests target the devel branch, or a staging branch first when they come from a fork. Maintainers merge devel to main for each release.

• Respect the community’s time and effort that goes into feedback and support.

• How to contribute to audit development
  • Adding code
  • Considerations
  • Layout
    • Content
    • Metadata
  • Gotchas
• How to Contribute to Remediate Development
  • Remediate Code Summary
  • Remediate Code Considerations
    • General Layout
    • Variables
    • STIG Control Task Layout
    • CIS Control Task Layout
• Molecule - Linux-Based Container Testing
  • Prerequisites
  • Repository layout
  • Scenario configuration
  • Running tests
  • Idempotency
  • Linting integration
  • Platforms and ARM64
  • CI/CD pipelines
  • Troubleshooting
  • Best Practices