Metal3 projects are Apache 2.0 licensed and accept contributions via GitHub pull requests. Those guidelines are the same as the Cluster API guidelines
By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the DCO file for details.
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.
- Submit a pull request.
All code PR must be labeled with one of
⚠️ (:warning:, major or breaking changes)- ✨ (:sparkles:, minor or feature additions)
- 🐛 (:bug:, patch and bugfixes)
- 📖 (:book:, documentation or proposals)
- 🏃 (:running:, other)
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 maintains older versions through release-X.Y branches. We accept
backports of bug fixes to the most recent
release branch. For example, if the most recent branch is release-0.2, and the
master branch is under active
development for v0.3.0, a bug fix that merged to master that also affects
v0.2.x may be considered for backporting
to release-0.2. We generally do not accept PRs against older release branches.
Breaking changes are generally allowed in the master branch, as this is the
branch used to develop the next minor release of Cluster API.
There may be times, however, when master is closed for breaking changes. This
is likely to happen as we near the release of a new minor version.
Breaking changes are not allowed in release branches, as these represent minor versions that have already been released. These versions have consumers who expect the APIs, behaviors, etc. to remain stable during the life time of the patch stream for the minor release.
Examples of breaking changes include:
- Removing or renaming a field in a CRD
- Removing or renaming a CRD
- Removing or renaming an exported constant, variable, type, or function
- Updating the version of critical libraries such as controller-runtime, client-go, apimachinery, etc.
- Some version updates may be acceptable, for picking up bug fixes, but maintainers must exercise caution when reviewing.
There may, at times, need to be exceptions where breaking changes are allowed in
release branches. These are at the discretion of the project's maintainers, and
must be carefully considered before merging. An example of an allowed
breaking change might be a fix for a behavioral bug that was released in an
initial minor version (such as v0.3.0).
Please see the Kubernetes community document on pull requests for more information about the merge process.
To gain viewing permissions to google docs in this project, please join the metal3-dev 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 Metal3-io organization GitHub organization.
Metal3 maintainers can assign you an issue or pull request by leaving a
/assign <your Github ID> comment on the issue or pull request.