- Contributor License Agreements
- Finding Things That Need Help
- Contributing a Patch
- Backporting a Patch
Read the following guide if you're interested in contributing to cluster-api.
We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles.
Please fill out either the individual or corporate Contributor License Agreement (CLA). More information about the CLA and instructions for signing it can be found here.
NOTE: Only original source code from you and other people that have signed the CLA can be accepted into the repository.
If you're new to the project and want to help, but don't know where to start, we have a semi-curated list of issues that should not need deep knowledge of the system. Have a look and see if anything sounds interesting. Alternatively, read some of the docs on other controllers and try to write your own, file and fix any/all issues that come up, including gaps in documentation!
- If you haven't already done so, sign a Contributor License Agreement (see details above).
- Fork the desired repo, develop and test your code changes.
- See the Development Guide for more instructions on setting up your environment and testing changes locally.
- Submit a pull request.
- All PRs should be labeled with one of
⚠️ (:warning:, major or breaking changes)- ✨ (
:sparkles:, feature additions) - 🐛 (
:bug:, patch and bug fixes) - 📖 (
:book:, documentation or proposals) - 💚 (
:green_heart:, testing) - 💎 (
:gem:, refactor) - 🔧 (
:wrench:, dev tooling and chores) - 🌱 (
:seedling:, update dependencies, minor or other)
- All code changes must be covered by unit tests and E2E tests.
- All new features should come with user documentation.
- All PRs should be labeled with one of
- Once the PR has been reviewed and is ready to be merged, commits should be squashed.
- Ensure that commit message(s) are be meaningful and commit history is readable.
All changes must be code reviewed. Coding conventions and standards are explained in the official developer docs. Expect reviewers to request that you avoid common go style mistakes in your PRs.
Cluster API ships older versions through release-X.X branches, usually backports are reserved to critical bug-fixes.
Some release branches might ship with both Go modules and dep (e.g. release-0.1), users backporting patches should always make sure
that the vendored Go modules dependencies match the Gopkg.lock and Gopkg.toml ones by running dep ensure
Cluster API maintainers may add "LGTM" (Looks Good To Me) or an equivalent comment to indicate that a PR is acceptable. Any change requires at least one LGTM. No pull requests can be merged until at least one Cluster API maintainer signs off with an LGTM.
To gain viewing permissions to google docs in this project, please join either the kubernetes-dev or kubernetes-sig-cluster-lifecycle google group.
Anyone may comment on issues and submit reviews for pull requests. However, in order to be assigned an issue or pull request, you must be a member of the Kubernetes SIGs GitHub organization.
If you are a Kubernetes GitHub organization member, you are eligible for membership in the Kubernetes SIGs GitHub organization and can request membership by opening an issue against the kubernetes/org repo.
However, if you are a member of any of the related Kubernetes GitHub organizations but not of the Kubernetes org, you will need explicit sponsorship for your membership request. You can read more about Kubernetes membership and sponsorship here.
Cluster API maintainers can assign you an issue or pull request by leaving a
/assign <your Github ID> comment on the issue or pull request.
- Mentoring Initiatives - We have a diverse set of mentorship programs available that are always looking for volunteers!