|
1 | 1 | # Contributing guidelines
|
2 | 2 |
|
3 |
| -## Sign the CLA |
| 3 | +## Contributor License Agreements |
4 | 4 |
|
5 |
| -Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests. Please see the CLA [guidelines](https://git.k8s.io/community/CLA.md) for more info |
| 5 | +We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles. |
6 | 6 |
|
7 |
| -### Contributing A Patch |
| 7 | +Please fill out either the individual or corporate Contributor License Agreement (CLA). More information about the CLA |
| 8 | +and instructions for signing it [can be found here](https://git.k8s.io/community/CLA.md). |
| 9 | + |
| 10 | +***NOTE***: Only original source code from you and other people that have signed the CLA can be accepted into the |
| 11 | +repository. |
| 12 | + |
| 13 | +## Versioning |
| 14 | + |
| 15 | +### Branches |
| 16 | + |
| 17 | +CAPV has two types of branches: the *main* branch and *release-X* branches. |
| 18 | + |
| 19 | +The *main* branch is where development happens. All the latest and |
| 20 | +greatest code, including breaking changes, happens on main. |
| 21 | + |
| 22 | +The *release-X* branches contain stable, backwards compatible code. On every |
| 23 | +major or minor release, a new branch is created. It is from these |
| 24 | +branches that minor and patch releases are tagged. In some cases, it may |
| 25 | +be necessary to open PRs for bugfixes directly against stable branches, but |
| 26 | +this should generally not be the case. |
| 27 | + |
| 28 | +### Backporting a patch |
| 29 | + |
| 30 | +We generally do not accept PRs directly against release branches, while we might accept backports of fixes/changes already |
| 31 | +merged into the main branch. In most cases the cherry-pick bot can and should be used to automate opening a cherry-pick PR. |
| 32 | + |
| 33 | +We generally allow backports of following changes to all supported branches: |
| 34 | +- Bug fixes and security fixes |
| 35 | +- Dependency bumps for CVEs (usually limited to CVE resolution; backports of non-CVE related version bumps are considered exceptions to be evaluated case by case) |
| 36 | +- Changes required to support new Kubernetes versions, when possible. |
| 37 | +- Changes to use the latest Go patch release. If the Go minor version of a supported branch goes out of support, we will consider on a case-by-case basis |
| 38 | + to bump to a newer Go minor version (e.g. to pick up CVE fixes). |
| 39 | +- Improvements to test and CI signal |
| 40 | + |
| 41 | +In addition to that we allow backports at maintainers discretion. Please let us know if you would like us to consider backporting a specific PR. |
| 42 | + |
| 43 | +In general, we support the two latest release branches. In addition, we will keep the CI coverage for older branches around so we're able to cut additional patch |
| 44 | +releases to fix CVEs and critical bugs if needed. |
| 45 | + |
| 46 | +## Contributing A Patch |
8 | 47 |
|
9 | 48 | 1. Submit an issue describing your proposed change to the repo in question.
|
10 | 49 | 1. The [repo owners](OWNERS) will respond to your issue promptly.
|
|
0 commit comments