Skip to content

Commit 320755a

Browse files
authored
Add changelog policy to contribution guidelines (#9378)
* Add changelog policy to contribution guidelines * Address feedback
1 parent 0b40ce4 commit 320755a

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,23 @@ Here is a recommended way to get setup:
144144
6. Write code, open a PR from your branch when you're ready
145145
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`
146146

147+
## Changelog Conventions
148+
149+
What warrants a changelog entry?
150+
151+
- Any change that affects the public API, visual appearance or user security *must* have a changelog entry
152+
- Any performance improvement or bugfix *should* have a changelog entry
153+
- Any contribution from a community member *may* have a changelog entry, no matter how small
154+
- Any documentation related changes *should not* have a changelog entry
155+
- Any regression change introduced and fixed within the same release *should not* have a changelog entry
156+
- Any internal refactoring, technical debt reduction, render test, unit test or benchmark related change *should not* have a changelog entry
157+
158+
How to add your changelog?
159+
160+
- Any changelog entry should be descriptive and concise; it should explain the change to a reader without context
161+
- Any changelog entry should be added to the pull request in the following format: `<changelog>Changelog description</changelog>`
162+
- Any change that does not require a changelog should be labelled `skip changelog`
163+
147164
## Documentation Conventions
148165

149166
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/).

0 commit comments

Comments
 (0)