Skip to content

Commit 6955ad6

Browse files
committed
📝💅 Split trivial change log category into 3
The new change note types are `packaging`, `contrib` and `misc`. `packaging` is intended for the audience of downstream redistributors. The `contrib` notes are meant to be documenting news affecting the project contributors, their development, and processes. Finally, `misc` is for things that don't fit anywhere but are still desired to be documented for some reason.
1 parent c0ff4a7 commit 6955ad6

File tree

2 files changed

+30
-4
lines changed

2 files changed

+30
-4
lines changed

changelog/README.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,22 @@ Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
2020
* ``deprecation``: feature deprecation.
2121
* ``breaking``: a change which may break existing suites, such as feature removal or behavior change.
2222
* ``vendor``: changes in packages vendored in pytest.
23-
* ``trivial``: fixing a small typo or internal change that might be noteworthy.
23+
* ``packaging``: notes for downstreams about unobvious side effects
24+
and tooling. changes in the test invocation considerations and
25+
runtime assumptions.
26+
* ``contrib``: stuff that affects the contributor experience. e.g.
27+
Running tests, building the docs, setting up the development
28+
environment.
29+
* ``misc``: changes that are hard to assign to any of the above
30+
categories.
2431

2532
So for example: ``123.feature.rst``, ``456.bugfix.rst``.
2633

34+
.. tip::
35+
36+
See :file:`pyproject.toml` for all available categories
37+
(``tool.towncrier.type``).
38+
2739
If your PR fixes an issue, use that number here. If there is no issue,
2840
then after you submit the PR and get the PR number you can add a
2941
changelog using that instead.

pyproject.toml

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -414,9 +414,23 @@ name = "Improved documentation"
414414
showcontent = true
415415

416416
[[tool.towncrier.type]]
417-
# Changes that might not even be worth exposing to the end users.
418-
directory = "trivial"
419-
name = "Trivial/internal changes"
417+
# Notes for downstreams about unobvious side effects and tooling. Changes
418+
# in the test invocation considerations and runtime assumptions.
419+
directory = "packaging"
420+
name = "Packaging updates and notes for downstreams"
421+
showcontent = true
422+
423+
[[tool.towncrier.type]]
424+
# Stuff that affects the contributor experience. e.g. Running tests,
425+
# building the docs, setting up the development environment.
426+
directory = "contrib"
427+
name = "Contributor-facing changes"
428+
showcontent = true
429+
430+
[[tool.towncrier.type]]
431+
# Changes that are hard to assign to any of the above categories.
432+
directory = "misc"
433+
name = "Miscellaneous internal changes"
420434
showcontent = true
421435

422436
[tool.mypy]

0 commit comments

Comments
 (0)