github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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

per the ongoing conversation at GoogleCloudPlatform/kubernetes#6213

Signed-off-by: António Meireles <antonio.meireles@reformi.st>
pull/6/head
António Meireles 2015-04-06 20:29:32 +01:00
parent 1ccfa589e7
commit 6a872af29a
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/devel/releasing.md
View File

@ -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).