summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKubernetes Prow Robot <k8s-ci-robot@users.noreply.github.com>2019-12-15 17:39:37 -0800
committerGitHub <noreply@github.com>2019-12-15 17:39:37 -0800
commitb8080af21f7157a140f3784ca9264bd00ac33f94 (patch)
tree9abee7d40dbef814c22394552d2b0b88de2a1ced
parent9ce7024e10d001d8c3c60a25bad3f7c037c33b3c (diff)
parenta835e357bfef20f6816fad308302e97d02f14361 (diff)
Merge pull request #4282 from saschagrunert/release-notes-review
Add release notes review section
-rw-r--r--contributors/guide/release-notes.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/contributors/guide/release-notes.md b/contributors/guide/release-notes.md
index 32d7160a..3c68e085 100644
--- a/contributors/guide/release-notes.md
+++ b/contributors/guide/release-notes.md
@@ -76,6 +76,22 @@ To see how to format your release notes, view the kubernetes/kubernetes [pull re
Release notes apply to pull requests on the master branch. For patch release branches the automated cherry-pick pull requests process (see the [cherry-pick instructions](/contributors/devel/sig-release/cherry-picks.md)) should be followed. That automation will pull release notes from the master branch PR from which the cherry-pick originated. On a rare occasion a pull request on a patch release branch is not a cherry-pick, but rather is targeted directly to the non-master branch and in this case, a `release-note-*` label is required for that non-master pull request.
+## Reviewing Release Notes
+
+Reviewing the release notes of a pull request should be a dedicated step in the
+overall review process. It is necessary to rely on the same metrics as other
+reviewers to be able to distinguish release notes which might need to be
+rephrased.
+
+As a guideline, a release notes entry needs to be rephrased if one of the
+following cases apply:
+
+- The release note does not communicate the full purpose of the change.
+- The release note has no impact on any user.
+- The release note is grammatically incorrect.
+
+In any other case the release note should be fine.
+
## Related
* [Behind The Scenes: Kubernetes Release Notes Tips & Tricks - Mike Arpaia, Kolide (KubeCon 2018 Lightning Talk)](https://www.youtube.com/watch?v=n62oPohOyYs)