diff options
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 2 | ||||
| -rw-r--r-- | doc/development_guide/contributor_guide/contribute.rst | 2 | ||||
| -rw-r--r-- | towncrier.toml | 17 |
3 files changed, 16 insertions, 5 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 82bd53ea5..4884d4353 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,7 +5,7 @@ To ease the process of reviewing your PR, do make sure to complete the following - [ ] Write a good description on what the PR does. - [ ] Create a news fragment with `towncrier create <IssueNumber>.<type>` which will be - included in the changelog. `<type>` can be one of: new_check, removed_check, extension, + included in the changelog. `<type>` can be one of: breaking, user_action, new_check, removed_check, extension, false_positive, false_negative, bugfix, other, internal. If necessary you can write details or offer examples on how the new change is supposed to work. - [ ] If you used multiple emails or multiple names when contributing, add your mails diff --git a/doc/development_guide/contributor_guide/contribute.rst b/doc/development_guide/contributor_guide/contribute.rst index 32de20106..ad20ebc6e 100644 --- a/doc/development_guide/contributor_guide/contribute.rst +++ b/doc/development_guide/contributor_guide/contribute.rst @@ -67,7 +67,7 @@ your patch gets accepted: .. keep this in sync with the description of PULL_REQUEST_TEMPLATE.md! - Create a news fragment with `towncrier create <IssueNumber>.<type>` which will be - included in the changelog. `<type>` can be one of: new_check, removed_check, extension, + included in the changelog. `<type>` can be one of: breaking, user_action, new_check, removed_check, extension, false_positive, false_negative, bugfix, other, internal. If necessary you can write details or offer examples on how the new change is supposed to work. diff --git a/towncrier.toml b/towncrier.toml index b25b28298..89853e2b1 100644 --- a/towncrier.toml +++ b/towncrier.toml @@ -7,9 +7,20 @@ issue_format = "`#{issue} <https://github.com/PyCQA/pylint/issues/{issue}>`_" wrap = true # Definition of fragment types. -# TODO: with the next towncrier release (21.9.1) it will be possible to define -# custom types as toml tables: -# https://github.com/twisted/towncrier#further-options +# We want the changelog to show in the same order as the fragment types +# are defined here. Therefore we have to use the array-style fragment definition. +# The table-style definition, although more concise, would be sorted alphabetically. +# https://github.com/twisted/towncrier/issues/437 +[[tool.towncrier.type]] +directory = "breaking" +name = "Breaking Changes" +showcontent = true + +[[tool.towncrier.type]] +directory = "user_action" +name = "Changes requiring user actions" +showcontent = true + [[tool.towncrier.type]] directory = "new_check" name = "New Checks" |