Skip to content

Commit 7ad2bba

Browse files
committed
Add docs about updating changelog
1 parent 11a112f commit 7ad2bba

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/contributing.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,19 @@ To format code:
5757
> yapf -ipr tests
5858
5959
You can also run the ``./scripts/test`` script to check flake8 and yapf.
60+
61+
CHANGELOG
62+
^^^^^^^^^
63+
64+
PySTAC maintains a `changelog <https://github.com/stac-utils/pystac/blob/develop/CHANGELOG.md>`_
65+
to track changes between releases. All PRs should make a changelog entry unless
66+
the change is trivial (e.g. fixing typos) or is entirely invisible to users who may
67+
be upgrading versions (e.g. an improvement to the CI system).
68+
69+
For changelog entries, please link to the PR of that change. This needs to happen in a few steps:
70+
71+
- Make a PR to PySTAC with your changes
72+
- Record the link to the PR
73+
- Push an additional commit to your branch with the changelog entry with the link to the PR.
74+
75+
For more information on changelogs and how to write a good entry, see `keep a changelog <https://keepachangelog.com/en/1.0.0/>`_

0 commit comments

Comments
 (0)