You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+20-12Lines changed: 20 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,10 @@ avoid common [go style mistakes](https://github.com/golang/go/wiki/CodeReviewCom
61
61
62
62
Cluster API uses [GitHub milestones](https://github.com/kubernetes-sigs/cluster-api/milestones) to track releases.
63
63
64
-
- Minor versions CAN be planned and scheduled twice / calendar year.
64
+
- Minor versions CAN be planned and scheduled twice in a calendar year.
65
+
- Each minor version is preceded with one or more planning session.
66
+
- Planning consists of one or more backlog grooming meetings, roadmap amendments,
67
+
and CAEP proposal reviews.
65
68
- Patch versions CAN be planned and scheduled each month for each of the currently supported series (usually N and N-1).
66
69
- Code freeze is in effect 72 hours (3 days) before a release.
67
70
- Maintainers should communicate the code freeze date at a community meeting preceding the code freeze date.
@@ -74,6 +77,22 @@ Cluster API uses [GitHub milestones](https://github.com/kubernetes-sigs/cluster-
74
77
- Dates in a release are approximations and always subject to change.
75
78
-`Next` milestone is for work that has been triaged, but not prioritized/accepted for any release.
76
79
80
+
## Proposal process (CAEP)
81
+
82
+
The Cluster API Enhacement Proposal is the process this project uses to adopt new features, changes to the APIs, changes to contracts between components, or changes to CLI interfaces.
83
+
84
+
The [template](https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/proposals/YYYYMMDD-template.md), and accepted proposals live under [docs/proposals](https://github.com/kubernetes-sigs/cluster-api/tree/master/docs/proposals).
85
+
86
+
- Proposals or requests for enhacements (RFEs) MUST be associated with an issue.
87
+
- Issues can be placed on the roadmap during planning if there is one or more folks
88
+
that can dedicate time to writing a CAEP and/or implementating it after approval.
89
+
- A proposal SHOULD be introduced and discussed during the weekly community meetings,
90
+
[Kubernetes SIG Cluster Lifecycle mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-lifecycle),
91
+
or [discuss forum](https://discuss.kubernetes.io/c/contributors/cluster-api/).
92
+
- Submit and discuss proposals using a collaborative writing platform, preferably Google Docs, share documents with edit permissions with the [Kubernetes SIG Cluster Lifecycle mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-lifecycle).
93
+
- A proposal in a Google Doc MUST turn into a [Pull Request](https://github.com/kubernetes-sigs/cluster-api/pulls).
94
+
- Proposals MUST be merged and in `implementable` state to be considered part of a major or minor release.
95
+
77
96
## Triaging E2E test failures
78
97
79
98
When you submit a change to the Cluster API repository as set of validation jobs is automatically executed by
@@ -137,17 +156,6 @@ Open [issues](https://github.com/kubernetes-sigs/cluster-api/issues/new/choose)
137
156
138
157
For big feature, API and contract amendments, we follow the CAEP process as outlined below.
139
158
140
-
## Proposal process (CAEP)
141
-
142
-
The Cluster API Enhacement Proposal is the process this project uses to adopt new features, or changes to the APIs.
143
-
144
-
- The template, and accepted proposals live under `docs/proposals`.
145
-
- A proposal SHOULD be introduced and discussed during the weekly community meetings,
146
-
[Kubernetes SIG Cluster Lifecycle mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-lifecycle),
147
-
or [discuss forum](https://discuss.kubernetes.io/c/contributors/cluster-api/).
148
-
- A proposal SHOULD be submitted first to the community using a collaborative writing platform, preferably Google Docs.
149
-
- When using Google Docs, share the document with edit permissions for the [Kubernetes SIG Cluster Lifecycle mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-lifecycle).
150
-
151
159
## Experiments
152
160
153
161
Proof of concepts, code experiments, or other initiatives can live under the `exp` folder and behind a feature gate.
0 commit comments