Skip to content

K
k3s
Commit 6a872af2 authored by António Meireles's avatar António Meireles
Browse files
Options

adding release notes guidelines to the (new) releases policy.

per the ongoing conversation at GoogleCloudPlatform/kubernetes#6213 Signed-off-by: 's avatarAntónio Meireles <antonio.meireles@reformi.st>
parent 1ccfa589
Hide whitespace changes
Inline Side-by-side
Showing with 13 additions and 0 deletions
docs/devel/releasing.md
View file @ 6a872af2
...@@ -150,3 +150,16 @@ not present in Docker `v1.2.0`: ...@@ -150,3 +150,16 @@ not present in Docker `v1.2.0`:
(Non-empty output here means the commit is not present on v1.2.0.) (Non-empty output here means the commit is not present on v1.2.0.)
``` ```
## Release Notes
No official release should be made final without properly matching release notes.
There should be made available, per release, a small summary, preamble, of the
major changes, both in terms of feature improvements/bug fixes and notes about
functional feature changes (if any) regarding the previous released version so
that the BOM regarding updating to it gets as obvious and trouble free as possible.
After this summary, preamble, all the relevant PRs/issues that got in that
version should be listed and linked together with a small summary understandable
by plain mortals (in a perfect world PR/issue's title would be enough but often
it is just too cryptic/geeky/domain-specific that it isn't).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment