Skip to content

Commit 7ba8381

Browse files
committed
Document backport policy
Signed-off-by: Stefan Büringer [email protected]
1 parent c1c6207 commit 7ba8381

File tree

2 files changed

+43
-4
lines changed

2 files changed

+43
-4
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,49 @@
11
# Contributing guidelines
22

3-
## Sign the CLA
3+
## Contributor License Agreements
44

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.
66

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
847

948
1. Submit an issue describing your proposed change to the repo in question.
1049
1. The [repo owners](OWNERS) will respond to your issue promptly.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ We also use the issue tracker to track features. If you have an idea for a featu
132132
[mailint_list]: https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-lifecycle
133133
[meeting_notes]: https://docs.google.com/document/d/1jQrQiOW75uWraPk4b_LWtCTHwT7EZwrWWwMdxeWOEvk/edit?usp=sharing
134134
[new_issue]: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/issues/new
135-
[prow]: https://go.k8s.io/bot-commands
135+
[prow]: https://prow.k8s.io/command-help?repo=kubernetes-sigs%2Fcluster-api-provider-vsphere
136136
[slack]: https://kubernetes.slack.com/messages/CKFGK3SSD
137137
[slack_info]: https://github.com/kubernetes/community/tree/master/communication#communication
138138
[troubleshooting]: ./docs/troubleshooting.md

0 commit comments

Comments
 (0)