Skip to content

Commit 22b6670

Browse files
committed
Improve docs re. CHANGELOG latest section
1 parent e346765 commit 22b6670

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[ ] Add tests for the change. In general, aim for full test coverage at the Python level. Rust tests are optional.
22
[ ] Add any appropriate documentation.
3-
[ ] Add a summary of changes to `CHANGELOG.rst`.
3+
[ ] Add a summary of changes to the `latest` section at the top of `CHANGELOG.rst`. (If it's not there, add it.)
44
[ ] Add your name to `AUTHORS.rst`.
55
[ ] Run `just full-check`.

CONTRIBUTING.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,14 @@ Before requesting a review
4040
- Ensure you have included tests that cover the change. In general, aim for full test coverage at the Python level.
4141
Rust tests are optional.
4242
- Update documentation when there's a new API, functionality etc.
43-
- Add a note to ``CHANGELOG.rst`` about the changes.
43+
- Add a note to ``CHANGELOG.rst`` about the changes, in the imperative mood. This should go under
44+
the main page title, under a ``latest`` section. If it's not there already, create it. E.g.::
45+
46+
latest
47+
------
48+
49+
* Add new feature.
50+
4451
- Add yourself to ``AUTHORS.rst``.
4552
- Run ``just full-check`` locally. (If you're a new contributor, CI checks are not run automatically.)
4653

0 commit comments

Comments
 (0)