From 6f10ad27a0208533354d605b6f13c77c5e2bc14f Mon Sep 17 00:00:00 2001 From: jinmu03 <36862642+jinmu03@users.noreply.github.com> Date: Wed, 13 Mar 2019 15:21:02 -0700 Subject: [PATCH] Modify Release Notes section in Contributing guide (#33162) * release notes * release notes * release notes * Update CONTRIBUTING.md Co-Authored-By: jinmu03 <36862642+jinmu03@users.noreply.github.com> * Update CONTRIBUTING.md Co-Authored-By: jinmu03 <36862642+jinmu03@users.noreply.github.com> --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index afe90683b61a..04b79b995c54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -454,7 +454,8 @@ node scripts/docs.js --open Part of this process only applies to maintainers, since it requires access to Github labels. -Kibana publishes major, minor and patch releases periodically through the year. During this process we run a script against this repo to collect the applicable PRs against that release and generate [Release Notes](https://www.elastic.co/guide/en/kibana/current/release-notes.html). To include your change in the Release Notes: +Kibana publishes major, minor and patch releases periodically through the year. During this process we run a script against this repo to collect the applicable PRs against that release and generate [Release Notes](https://www.elastic.co/guide/en/kibana/current/release-notes.html). +To include your change in the Release Notes: 1. In the title, summarize what the PR accomplishes in language that is meaningful to the user. In general, use present tense (for example, Adds, Fixes) in sentence case. 1. Label the PR with the targeted version (ex: 6.5). @@ -464,6 +465,9 @@ Kibana publishes major, minor and patch releases periodically through the year. * For a deprecated feature, use `release_note:deprecation`. * For a breaking change, use `release-breaking:note`. +To NOT include your changes in the Release Notes, please use label`non-issue`. PRs with the following labels also won't be included in the Release Notes: +`build`, `docs`, `test`, `non-issue`, `jenkins`, `backport`, and `chore`. + We also produce a blog post that details more important breaking API changes every minor and major release. If the PR includes a breaking API change, apply the label `release_note:dev_docs`. Additionally add a brief summary of the break at the bottom of the PR using the format below: