Contributing

Contributing to EPAR

Thanks for taking the time to contribute.

Before You Start

• Use GitHub issues to discuss bugs, documentation gaps, and proposed changes before starting substantial work.
• Do not report security vulnerabilities in public issues. Follow Security instead.
• EPAR runs GitHub Actions jobs on trusted infrastructure. Changes that affect runners, credentials, container privileges, workflow permissions, or cleanup boundaries need clear security reasoning and tests.

Development Workflow

1. Fork the repository and create a focused branch from develop.
2. Read and preserve the Development and Extension Principles.
3. Keep the change small and document any operational or security behavior that it changes.
4. Run the relevant tests locally. The baseline Go test suite is go test ./....
5. Open a pull request targeting develop and complete the pull-request template.

Fork pull requests run the safe hosted verification workflow. The live EPAR canary is reserved for branches in this repository because it uses a protected environment and disposable privileged containers.

Pull Request Expectations

• Explain the problem, the approach, and how you tested it.
• Add or update tests when behavior changes.
• Keep credentials, private keys, tokens, and machine-specific configuration out of commits.
• Update the relevant documentation when a user-visible or operational behavior changes.
• Document and test every intentional platform or security exception.

By contributing, you agree to follow the Code of Conduct.

See the development documentation for the architecture, provider extension checklist, verification infrastructure, and release process.