Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add changelog policy to contribution guidelines #9378

Merged
merged 2 commits into from
Mar 5, 2020
Merged

Add changelog policy to contribution guidelines #9378

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ad919d
Add changelog policy to contribution guidelines
karimnaaji Mar 5, 2020
46f5cac
Address feedback
karimnaaji Mar 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Copy link
Contributor Author

@karimnaaji karimnaaji Mar 5, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mapbox/gl-js The list is not exhaustive, feel free to suggest any other entry to add/remove here


- 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would condense some of these into one lines — not need to be too explicit since this is hard to read, e.g.:

  • Any change that affects the public API, visual appearance or user security ...
  • Any bug fix or a performance improvement ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep that's a good point, tried to condense for conventions that were similar

- Any changelog entry should be added to the pull request in the following format: `<changelog>Changelog description</changelog>`
- 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/).
Expand Down