Skip to content

Commit

Permalink
📝💅 Split trivial change log category into 3
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
webknjaz committed Jun 20, 2024
1 parent c0ff4a7 commit 6955ad6
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 4 deletions.
14 changes: 13 additions & 1 deletion changelog/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,22 @@ Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
* ``deprecation``: feature deprecation.
* ``breaking``: a change which may break existing suites, such as feature removal or behavior change.
* ``vendor``: changes in packages vendored in pytest.
* ``trivial``: fixing a small typo or internal change that might be noteworthy.
* ``packaging``: notes for downstreams about unobvious side effects
and tooling. changes in the test invocation considerations and
runtime assumptions.
* ``contrib``: stuff that affects the contributor experience. e.g.
Running tests, building the docs, setting up the development
environment.
* ``misc``: changes that are hard to assign to any of the above
categories.

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

.. tip::

See :file:`pyproject.toml` for all available categories
(``tool.towncrier.type``).

If your PR fixes an issue, use that number here. If there is no issue,
then after you submit the PR and get the PR number you can add a
changelog using that instead.
Expand Down
20 changes: 17 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -414,9 +414,23 @@ name = "Improved documentation"
showcontent = true

[[tool.towncrier.type]]
# Changes that might not even be worth exposing to the end users.
directory = "trivial"
name = "Trivial/internal changes"
# Notes for downstreams about unobvious side effects and tooling. Changes
# in the test invocation considerations and runtime assumptions.
directory = "packaging"
name = "Packaging updates and notes for downstreams"
showcontent = true

[[tool.towncrier.type]]
# Stuff that affects the contributor experience. e.g. Running tests,
# building the docs, setting up the development environment.
directory = "contrib"
name = "Contributor-facing changes"
showcontent = true

[[tool.towncrier.type]]
# Changes that are hard to assign to any of the above categories.
directory = "misc"
name = "Miscellaneous internal changes"
showcontent = true

[tool.mypy]
Expand Down

0 comments on commit 6955ad6

Please sign in to comment.