From 994013665ddbe03e21869a9d5c849577422196c7 Mon Sep 17 00:00:00 2001 From: Vladimir Agafonkin Date: Thu, 5 Mar 2020 18:08:19 +0200 Subject: [PATCH] Add changelog policy to contribution guidelines (#9378) * Add changelog policy to contribution guidelines * Address feedback --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f6ec877014..a8d791b12c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -144,6 +144,23 @@ 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 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, 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 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/).