Skip to content

Commit

Permalink
updating the removal towncrier usage to be an explicit sdk category
Browse files Browse the repository at this point in the history
  • Loading branch information
ouchadam committed Jan 14, 2022
1 parent 37aadf4 commit 7259324
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Supported filename extensions are:
- ``.bugfix``: Signifying a bug fix.
- ``.wip``: Signifying a work in progress change, typically a component of a larger feature which will be enabled once all tasks are complete.
- ``.doc``: Signifying a documentation improvement.
- ``.removal``: Signifying a deprecation or removal of public API. Can be used to notifying about API change in the Matrix SDK
- ``.sdk``: Signifying a change to the Matrix SDK, this could be an addition, deprecation or removal of a public API.
- ``.misc``: Any other changes.

See https://github.com/twisted/towncrier#news-fragments if you need more details.
Expand Down
2 changes: 1 addition & 1 deletion towncrier.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
showcontent = true

[[tool.towncrier.type]]
directory = "removal"
directory = "sdk"
name = "SDK API changes ⚠️"
showcontent = true

Expand Down

0 comments on commit 7259324

Please sign in to comment.