Skip to content

Commit

Permalink
update documentation to reference towncrier news fragments
Browse files Browse the repository at this point in the history
  • Loading branch information
zacharyburnett committed Aug 19, 2024
1 parent 064d14f commit bfedcfa
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ If this PR fixes an issue, please add closing keywords (eg 'fixes #XXX')

- [ ] pre-commit checks ran successfully
- [ ] tests ran successfully
- [ ] for a public change, a changelog entry was added
- [ ] for a public change, documentation was updated
- [ ] for a public change, added news fragment (`changes/<PR#>.<changetype>.rst`)
- [ ] for a public change, updated documentation
- [ ] for any new features, unit tests were added
2 changes: 2 additions & 0 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
- run: pip install towncrier
- run: towncrier check
10 changes: 10 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,13 @@ to the maintainers, who are glad to assist you.
a maintainer, you can comment ``@meeseeksdev backport to <branch>`` on a pull
request to manually trigger a backport. Moreover, when merging a "backport"
pull request, please use the "Rebase and merge" option.

.. note::
When making a public change, add a news fragment to ``changes/`` with the
filename ``<PR#>.<changetype>.rst``. The change types are as follows:

- ``feature``: new feature
- ``bugfix``: bug fix
- ``doc``: documentation change
- ``removal``: deprecation or removal of public API
- ``misc``: not of interest to users

0 comments on commit bfedcfa

Please sign in to comment.