Update pull request template to reference towncrier.

jaraco · Dec 30, 2024 · 7b7a5b3 · 7b7a5b3
1 parent bb11bad
commit 7b7a5b3
Showing 1 changed file with 13 additions and 13 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -8,30 +8,30 @@ For information, read and make sure you're okay with the [Contributing guideline
 - [ ] Docstrings for the Calendar class and specific methods.
 - [ ] Use the ``workalendar.registry_tools.iso_register`` decorator to register your new calendar using ISO codes (optional).
 - [ ] Calendar country / label added to the README.md file.
-- [ ] Changelog amended with a mention like: "Added ``<country>`` by ``@pseudo`` (#)". **Note** *Please do NOT change the version number here. It's the project maintainers' duty.*
+- [ ] Create a changelog entry using [`towncrier`](https://towncrier.readthedocs.io/) (e.g. ```towncrier -c "Added ``country``." $ISSUE.feature.rst```)
 
 <!-- if your contribution is a fix -->
 
 - [ ] Tests with a significant number of years to be tested for your calendar.
-- [ ] Changelog amended with a mention describing your changes. **Note** *Please do NOT change the version number here. It's the project maintainers' duty.*
+- [ ] Create a changelog entry using [`towncrier`](https://towncrier.readthedocs.io/) (e.g. ```towncrier -c "Fixed XYZ for ``country``." $ISSUE.feature.rst```).
 
 <!-- Release management
 
 - Commit for the tag:
-    - [ ] Edit version in setup.cfg
-    - [ ] Add version in Changelog.md ; trim things
-    - [ ] Push & wait for the tests to be green
-    - [ ] tag me.
-    - [ ] build sdist + wheel packages (``make package``)
+	- [ ] Edit version in setup.cfg
+	- [ ] Add version in Changelog.md ; trim things
+	- [ ] Push & wait for the tests to be green
+	- [ ] tag me.
+	- [ ] build sdist + wheel packages (``make package``)
 - Back to dev commit:
-    - [ ] Edit version in setup.cfg
-    - [ ] Add the "master / nothing to see here" in Changelog.md
-    - [ ] Push & wait for the tests to be green
+	- [ ] Edit version in setup.cfg
+	- [ ] Add the "master / nothing to see here" in Changelog.md
+	- [ ] Push & wait for the tests to be green
 - [ ] Merge --ff
 - Github stuff
-    - [ ] Push tag in Github
-    - [ ] Edit release on Github using the changelog.
-    - [ ] Delete branch
+	- [ ] Push tag in Github
+	- [ ] Edit release on Github using the changelog.
+	- [ ] Delete branch
 - [ ] upload release on PyPI using ``twine``
 - [ ] (*optional*) Make feeback on the various PR or issues.