📝 Add contrib & packaging change note types

docs/changelog-fragments/.gitignore

@@ -8,6 +8,9 @@
 !*.breaking
 !*.breaking.rst
 !*.breaking.*.rst
+!*.contrib
+!*.contrib.rst
+!*.contrib.*.rst
 !*.deprecation
 !*.deprecation.rst
 !*.deprecation.*.rst
@@ -20,3 +23,6 @@
 !*.misc
 !*.misc.rst
 !*.misc.*.rst
+!*.packaging
+!*.packaging.rst
+!*.packaging.*.rst

docs/changelog-fragments/README.rst

@@ -41,11 +41,39 @@ your own!).
 Finally, name your file following the convention that Towncrier
 understands: it should start with the number of an issue or a
 PR followed by a dot, then add a patch type, like ``feature``,
-``doc``, ``bugfix`` etc., and add ``.rst`` as a suffix. If you
+``doc``, ``contrib`` etc., and add ``.rst`` as a suffix. If you
 need to add more than one fragment, you may add an optional
 sequence number (delimited with another period) between the type
 and the suffix.
 
+In general the name will follow ``<pr_number>.<category>.rst`` pattern,
+where the categories are:
+
+- ``bugfix``: A bug fix for something we deemed an improper undesired
+ behavior that got corrected in the release to match pre-agreed
+ expectations.
+- ``feature``: A new behavior, public APIs. That sort of stuff.
+- ``deprecation``: A declaration of future API removals and breaking
+ changes in behavior.
+- ``breaking``: When something public gets removed in a breaking way.
+ Could be deprecated in an earlier release.
+- ``doc``: Notable updates to the documentation structure or build
+ process.
+- ``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.
+
+A pull request may have more than one of these components, for example
+a code change may introduce a new feature that deprecates an old
+feature, in which case two fragments should be added. It is not
+necessary to make a separate documentation fragment for documentation
+changes accompanying the relevant code changes.
+
 -----------------------------------------------------------
 Examples for changelog entries adding to your Pull Requests
 -----------------------------------------------------------

pyproject.toml

@@ -113,6 +113,20 @@ profile = "True"
  name = "Improved documentation"
  showcontent = true
 
+ [[tool.towncrier.type]]
+ # 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"