diff options
| author | António Meireles <antonio.meireles@reformi.st> | 2015-04-06 20:29:32 +0100 |
|---|---|---|
| committer | António Meireles <antonio.meireles@reformi.st> | 2015-04-07 18:21:45 +0100 |
| commit | 655bbc697f92fe1229534c80a97a56862a4eb440 (patch) | |
| tree | 1d65688f1c92eb8498b3070768bba46d0d2f2f79 | |
| parent | 52f4cee414f94ee5fc58cf943b443094e6773094 (diff) | |
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>
| -rw-r--r-- | releasing.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/releasing.md b/releasing.md index 4cdf8827..125355c3 100644 --- a/releasing.md +++ b/releasing.md @@ -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.) ``` +## 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). |