Skip to main content

Contributions

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

How You Can Help ❤️​

Here are some of the best ways to contribute:

  • Define New Patterns: This is the most unique and impactful way to help. Thanks to our Pattern-as-Code approach, you can contribute new architectural patterns simply by creating or updating a JSON file. If you have identified a common best practice, a security vulnerability, or a reliability pattern, please share it! Check out our Pattern Catalog to get started.
  • Report Bugs: If you find something that isn't working as expected, please open an issue on GitHub. Be sure to include steps to reproduce the problem and any relevant manifest files.
  • Suggest Enhancements: Have an idea for a new feature or an improvement to an existing one? We'd love to hear it. You can open an issue to start a discussion.
  • Improve Documentation: Good documentation is key. If you find a typo, think a section is unclear, or want to add a new tutorial, you can submit a pull request to our documentation.
  • Contribute to the Core: If you're comfortable with Java, you can help improve the KubePattern core. This could mean fixing bugs, optimizing the analysis engine, or helping build new features.
  • Define new Relationships: If you're comfortable with Java, you can help improve KubePattern graph by defining new Relationships that are useful to catch new Patterns.

Getting Started: The Contribution Flow​

We follow a standard GitHub workflow for all contributions.

  1. Find or Create an Issue: Before starting work, please check our GitHub Issues to see if your idea or bug is already being discussed. If not, create a new one!
  2. Fork the Repository: Create your own fork of the KubePattern repository.
  3. Create a Branch: Create a new branch from main for your changes (e.g., feat/add-new-pattern or fix/typo-in-docs).
  4. Make Your Changes: Write your code, create your pattern JSON, or update the documentation.
  5. Submit a Pull Request (PR): Push your branch to your fork and open a pull request against the KubePattern main branch. Please provide a clear description of your changes in the PR.
  6. Review: A maintainer will review your PR, provide feedback, and merge it once it's approved.