Contributing
Issues, ideas, pull requests, commit conventions, tests, and how AI-assisted work is credited.
Kubemoot is an independent open-source project under the Apache 2.0 license. This
section is the one place that describes how the project works with the people around
it: how to reach us, how to contribute, who decides what, how conduct and security
reports are handled, and how releases are made. The kubemoot organization on GitHub
links here instead of repeating it.
| You want to | Go to |
|---|---|
| Ask a question, share an idea, or show what you built | GitHub Discussions |
| Report a defect or request a feature on a specific repo | An issue on that repo, using its template |
| Reach us about anything else: questions, speaking, press, teaching, partnerships | moot@kubemoot.org |
| Report a vulnerability (only) | security@kubemoot.org, never a public issue. See Security |
| Report a conduct concern | conduct@kubemoot.org. See Code of Conduct |
| See what changed in a release | The repository’s GitHub Releases page. See Releases |
| See where the project is headed | The Roadmap |
The security address is only for vulnerability reports. Every other question goes to moot@kubemoot.org or GitHub Discussions.
Use Discussions when you are not sure whether something is a bug. A Discussion can become an issue once it is clear what is broken; an issue opened too early usually turns into a question.
Kubemoot has no commercial support. Support is community, best effort, from the
maintainer. If you are new here, run the Quickstart
on an empty kind cluster first; it exercises the same path CI checks on every release,
and a failure there is the fastest route to a useful report.
See How Kubemoot Is Built and Secured for how the project’s practices meet the OpenSSF Best Practices criteria.
The kubemoot organization holds the operator (kubemoot), the packaged crews (crews), the command-line tool (kmctl), CrewForge for VS Code (vscode-crewforge), and this site (kubemoot-docs). The Ecosystem chapter describes what each one is. Organizations and individuals using Kubemoot can add themselves to the adopters list.
Issues, ideas, pull requests, commit conventions, tests, and how AI-assisted work is credited.
Set up a development environment: repository layout, prerequisites, and how to build and test each component.
Who maintains Kubemoot, how decisions are made, and how public issues and pull requests are handled.
The Contributor Covenant governs every Kubemoot space, and how to report a concern.
How to report a vulnerability, which versions get fixes, how the code is checked, and where the security model and known limitations are documented.
How changes are made, how versions and releases work, how the supply chain is protected, how the code is checked, and how the settings are managed, with a link to the evidence for each point.
How a merge to main becomes a release candidate and how a maintainer publishes it as a versioned release.