Skip to content

Commit

Permalink
Update Release Notes Document to reflect PR boilerplate changes
Browse files Browse the repository at this point in the history
  • Loading branch information
onyiny-ang committed Aug 16, 2019
1 parent 633434a commit a69e824
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions contributors/guide/release-notes.md
Expand Up @@ -4,7 +4,15 @@ weight: 1
slug: "adding-release-notes"
---

On the kubernetes/kubernetes repository, release notes are required for any pull request with user-visible changes, such as bug-fixes, feature additions, and output format changes.
On the kubernetes/kubernetes repository, release notes are required for any pull request with _user-visible changes_, this could mean:

- User facing, critical bug-fixes
- Notable feature additions
- Output format changes
- Deprecations or removals
- Metrics changes
- Dependency changes
- API changes

To meet this requirement, do one of the following:
- Add notes in the release notes block, or
Expand Down Expand Up @@ -32,6 +40,20 @@ For pull requests that don't need to be mentioned at release time, use the `/rel
NONE
```

To see how to format your release notes, view the kubernetes/kubernetes [pull request template](https://git.k8s.io/kubernetes/.github/PULL_REQUEST_TEMPLATE.md) for a brief example. Pull Request titles and body comments can be modified at any time prior to the release to make them friendly for release notes.
Ideally, your release note should be written in simple, easy to understand sentences. Users and the team that curates release notes are typically much less familiar with the deep technical implementation details included in your PR. When writing a release note, consider what _users_ need to know and write it so they can easily understand.
Some brief examples of release notes:

```
The deprecated flag --conntrack-max has been removed from kube-proxy. Users of this flag should switch to --conntrack-min and --conntrack-max-per-core instead. (#78399, @rikatz)
The --export flag for the kubectl get command, deprecated since v1.14, will be removed in v1.18.
Fixed a bug that prevents dry-run from being honored for the pod/eviction sub-resource. (#76969, @apelisse)
```


Pull Request titles and body comments can be modified at any time prior to the release to make them friendly for release notes.

The release notes team maintains a [template](https://github.com/kubernetes/sig-release/blob/master/release-team/role-handbooks/release-notes/relnotes-template.md) for Kubernetes Release notes that may help clarify whether or not your PR requires a release note. The most recent [Kubernetes Release notes](https://kubernetes.io/docs/setup/release/notes/) can also provide insight into the writing style for release notes.

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.

0 comments on commit a69e824

Please sign in to comment.