Skip to content

Commit

Permalink
Add docs about updating changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
lossyrob committed Mar 11, 2021
1 parent 11a112f commit 7ad2bba
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,19 @@ To format code:
> yapf -ipr tests
You can also run the ``./scripts/test`` script to check flake8 and yapf.

CHANGELOG
^^^^^^^^^

PySTAC maintains a `changelog <https://github.com/stac-utils/pystac/blob/develop/CHANGELOG.md>`_
to track changes between releases. All PRs should make a changelog entry unless
the change is trivial (e.g. fixing typos) or is entirely invisible to users who may
be upgrading versions (e.g. an improvement to the CI system).

For changelog entries, please link to the PR of that change. This needs to happen in a few steps:

- Make a PR to PySTAC with your changes
- Record the link to the PR
- Push an additional commit to your branch with the changelog entry with the link to the PR.

For more information on changelogs and how to write a good entry, see `keep a changelog <https://keepachangelog.com/en/1.0.0/>`_

0 comments on commit 7ad2bba

Please sign in to comment.