From 8ad919da268964e90cffa7f6f69ffbb11747c29a Mon Sep 17 00:00:00 2001 From: Karim Naaji Date: Wed, 4 Mar 2020 16:05:08 -0800 Subject: [PATCH 1/2] Add changelog policy to contribution guidelines --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f6ec877014..a549fad3079 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -144,6 +144,21 @@ Here is a recommended way to get setup: 6. Write code, open a PR from your branch when you're ready 7. If you need to rebase your fork's PR branch onto master to resolve conflicts: `git fetch upstream`, `git rebase upstream/master` and force push to Github `git push --force origin your-branch` +## Changelog Conventions + +What warrants a changelog entry? + +- Any change that introduces changes to the public API *must* have a changelog entry. +- Any change that affects user security *must* have a changelog entry +- Any user-facing or visually impacting change *must* have a changelog entry +- Any performance improvement *should* have a changelog entry +- Any bugfix *should* have a changelog entry +- Any contribution from a community member *may* have a changelog entry, no matter how small +- Any documentation related changes *should not* have a changelog entry +- Any regression change introduced and fixed within the same release *should not* have a changelog entry +- Any internal refactoring, technical debt reduction, render test or benchmark related change *should not* have a changelog entry +- Any changelog entry should be descriptive and concise; it should explain the change to a reader without context + ## Documentation Conventions See [`README.md`](https://github.com/mapbox/mapbox-gl-js-docs/blob/publisher-production/README.md) from [`mapbox-gl-js-docs`](https://github.com/mapbox/mapbox-gl-js-docs/). From 46f5cac582a52684053c98107e9b9e1c0e6fdd04 Mon Sep 17 00:00:00 2001 From: Karim Naaji Date: Thu, 5 Mar 2020 07:54:21 -0800 Subject: [PATCH 2/2] Address feedback --- CONTRIBUTING.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a549fad3079..a8d791b12c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -148,16 +148,18 @@ Here is a recommended way to get setup: What warrants a changelog entry? -- Any change that introduces changes to the public API *must* have a changelog entry. -- Any change that affects user security *must* have a changelog entry -- Any user-facing or visually impacting change *must* have a changelog entry -- Any performance improvement *should* have a changelog entry -- Any bugfix *should* have a changelog entry +- Any change that affects the public API, visual appearance or user security *must* have a changelog entry +- Any performance improvement or bugfix *should* have a changelog entry - Any contribution from a community member *may* have a changelog entry, no matter how small - Any documentation related changes *should not* have a changelog entry - Any regression change introduced and fixed within the same release *should not* have a changelog entry -- Any internal refactoring, technical debt reduction, render test or benchmark related change *should not* have a changelog entry +- Any internal refactoring, technical debt reduction, render test, unit test or benchmark related change *should not* have a changelog entry + +How to add your changelog? + - Any changelog entry should be descriptive and concise; it should explain the change to a reader without context +- Any changelog entry should be added to the pull request in the following format: `Changelog description` +- Any change that does not require a changelog should be labelled `skip changelog` ## Documentation Conventions