Skip to content

Commit 7b7a5b3

Browse files
committed
Update pull request template to reference towncrier.
1 parent bb11bad commit 7b7a5b3

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,30 @@ For information, read and make sure you're okay with the [Contributing guideline
88
- [ ] Docstrings for the Calendar class and specific methods.
99
- [ ] Use the ``workalendar.registry_tools.iso_register`` decorator to register your new calendar using ISO codes (optional).
1010
- [ ] Calendar country / label added to the README.md file.
11-
- [ ] 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.*
11+
- [ ] Create a changelog entry using [`towncrier`](https://towncrier.readthedocs.io/) (e.g. ```towncrier -c "Added ``country``." $ISSUE.feature.rst```)
1212

1313
<!-- if your contribution is a fix -->
1414

1515
- [ ] Tests with a significant number of years to be tested for your calendar.
16-
- [ ] Changelog amended with a mention describing your changes. **Note** *Please do NOT change the version number here. It's the project maintainers' duty.*
16+
- [ ] Create a changelog entry using [`towncrier`](https://towncrier.readthedocs.io/) (e.g. ```towncrier -c "Fixed XYZ for ``country``." $ISSUE.feature.rst```).
1717

1818
<!-- Release management
1919
2020
- Commit for the tag:
21-
- [ ] Edit version in setup.cfg
22-
- [ ] Add version in Changelog.md ; trim things
23-
- [ ] Push & wait for the tests to be green
24-
- [ ] tag me.
25-
- [ ] build sdist + wheel packages (``make package``)
21+
- [ ] Edit version in setup.cfg
22+
- [ ] Add version in Changelog.md ; trim things
23+
- [ ] Push & wait for the tests to be green
24+
- [ ] tag me.
25+
- [ ] build sdist + wheel packages (``make package``)
2626
- Back to dev commit:
27-
- [ ] Edit version in setup.cfg
28-
- [ ] Add the "master / nothing to see here" in Changelog.md
29-
- [ ] Push & wait for the tests to be green
27+
- [ ] Edit version in setup.cfg
28+
- [ ] Add the "master / nothing to see here" in Changelog.md
29+
- [ ] Push & wait for the tests to be green
3030
- [ ] Merge --ff
3131
- Github stuff
32-
- [ ] Push tag in Github
33-
- [ ] Edit release on Github using the changelog.
34-
- [ ] Delete branch
32+
- [ ] Push tag in Github
33+
- [ ] Edit release on Github using the changelog.
34+
- [ ] Delete branch
3535
- [ ] upload release on PyPI using ``twine``
3636
- [ ] (*optional*) Make feeback on the various PR or issues.
3737

0 commit comments

Comments
 (0)