📖 Document breaking changes policy #1637
Conversation
ncdc
added
kind/documentation
k8s-ci-robot
added
the
cncf-cla: yes
|
/cc @akutz |
k8s-ci-robot
added
the
size/M
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ncdc The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
cc @timothysc |
|
|
||
| ## Breaking Changes | ||
|
|
||
| Breaking changes are generally allowed in the `master` branch, as this is the branch used to develop the next minor |
There was a problem hiding this comment.
We should specify that this applies only if master is open for the next iteration
There was a problem hiding this comment.
I know Kubernetes sends out updates throughout the release cycle informing about the state of the master branch. Maybe we should do something similar (defer to #768?)
There was a problem hiding this comment.
That sounds good to me, let's document that as well?
There was a problem hiding this comment.
Yes, but as part of 768
There was a problem hiding this comment.
Eek, I linked to the wrong thing. Nevermind about 768 😄. We had talked at the f2f about formalizing the release cycle, which is what I was trying to link to, but I don't think we ever created an issue for it (or I can't find it quickly).
CONTRIBUTING.md
Outdated
|
|
||
| ### Merge Approval | ||
|
|
||
| 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. | ||
| 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 |
There was a problem hiding this comment.
This is hard to do in practice, given that any k8s contributor can, in theory add /lgtm to anything
There was a problem hiding this comment.
This isn't net new but I can adjust it
ncdc
force-pushed
the
docs/library-stability
branch
from
59c157a to
05d3472
Compare
Document breaking changes guidelines in the contributing doc. Also clean up word wrapping. Signed-off-by: Andy Goldstein <[email protected]>
ncdc
force-pushed
the
docs/library-stability
branch
from
05d3472 to
b3004ab
Compare
k8s-ci-robot
added
the
lgtm
What this PR does / why we need it:
Document breaking changes guidelines in the contributing doc. Also clean
up word wrapping.
Note, most of the diffs are just word wrapping the paragraphs, with the addition of the breaking changes section. I also cleaned up the formatting of the list with the PR title emojis.
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #1598