Skip to content

Commit

Permalink
update towncrier type details
Browse files Browse the repository at this point in the history
  • Loading branch information
bjlittle committed Dec 24, 2024
1 parent 2c97c69 commit c3b501e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
12 changes: 8 additions & 4 deletions docs/src/developer/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,21 @@ Each news fragment file **must** be named as `<PULL-REQUEST>.<TYPE>.rst`,
where `<PULL-REQUEST>` is the {fab}`github` pull-request number,
and `<TYPE>` is one of:

* `breaking`: Removals and backward incompatible breaking changes that may affect user code
* `breaking`: Removals and backward incompatible breaking changes that may affect user
code
* `deprecation`: Declaration of removals and backward incompatible changes
* `feature`: New user facing behaviours or capability
* `enhancement`: Updates to existing behaviours or capability, including performance
* `bugfix`: Correction to undesired behaviours or reported bugs
* `dependency`: Package dependency removals, additions, pins etc
* `asset`: Data, media and asset updates etc
* `documentation`: Notable changes to the documentation structure, content, render or build
* `documentation`: Notable changes to the documentation structure, content, render or
build
* `internal`: Miscellaneous internal and maintenance changes
* `community`: Celebrate our awesome community members and their contributions, including social changes
* `contributor`: Changes that affect contributors such as standards, conventions, running tests, building docs, environments etc
* `community`: Celebrate our awesome community members and their contributions,
including social changes
* `contributor`: Changes that affect contributors such as standards, conventions,
running tests, building docs, environments, security etc
* `misc`: Catch all for items that don't fit elsewhere

e.g., ``123.feature.rst`` or ``456.bugfix.rst``.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ showcontent = true

[[tool.towncrier.type]]
# Changes that affect contributors e.g., standards, conventions,
# running tests, building docs, environments etc
# running tests, building docs, environments, security etc
directory = "contributor"
name = "🛠️ Contributor Infrastructure"
showcontent = true
Expand Down

0 comments on commit c3b501e

Please sign in to comment.