Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update towncrier type details #1253

Merged
merged 1 commit into from
Dec 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading