Contributions

As an open-source project, we thrive on community support, and every contribution, big or small, is highly valued. Whether you are a developer, a Kubernetes architect, or just a documentation enthusiast, there are many ways to get involved.

How you can help ❤️

• Define new patterns. This is the most unique and impactful way to help. Thanks to the Pattern-as-Code approach, you can contribute a new smell simply by writing a YAML manifest, with no change to the engine. If you know a custom resource whose references tend to rot, or a best practice that depends on a companion resource, share it. See the Pattern reference to get started, and the Registry for what already exists.
• Report bugs. If something does not work as expected, open an issue.
• Suggest enhancements. Have an idea for a new feature or an improvement to an existing one? We would love to hear it. The roadmap shows what is already planned.
• Improve the documentation. Good documentation is key. If you find a typo, think a section is unclear, or want to add a tutorial, use the Edit this page on GitHub link at the bottom of any page, or send a pull request to the documentation repository.
• Contribute to the core. If you are comfortable with Go, you can help improve the KubePattern core: fix bugs, optimise the analysis engine, or build new features.

Working on the core

The project uses two long-lived branches. New features, experiments and bug fixes land on dev first, and only stable, tested code is merged into main, where releases are tagged. Open your pull request against dev. The repository's DEVELOPMENT.md describes the build and release pipelines in full.