Towncrier: what category for documentation fixes?

pigeonflight · September 25, 2020, 7:13pm

In the context of towncrier what category would changes to documentation fall under?
I only see these options:

* For bug fixes:  `42.bugfix` .
* For new features:  `42.feature` .
* For breaking changs:  `42.breaking` .

That's from this doc:

github.com

plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst

.. If this works for more Plone packages, we may want to add this to the guidelines at https://docs.plone.org/develop/coredev/docs/guidelines.html
.. This text is adapted from https://pip.pypa.io/en/latest/development/#adding-a-news-entry


For contributors
----------------

The ``CHANGES.rst`` file is managed using `towncrier <https://pypi.org/project/towncrier/>`_.
All non trivial changes must be accompanied by an entry in the ``news`` directory.
Using such a tool instead of editing the file directly, has the following benefits:

- It avoids merge conflicts in ``CHANGES.rst``.
- It avoids news entries ending up under the wrong version header.

The best way of adding news entries is this:

- First create an issue describing the change you want to make.
  The issue number serves as a unique indicator for the news entry.
  As example, let's say you have created issue 42.

This file has been truncated. show original

mauritsvanrees · September 25, 2020, 10:05pm

Please use bugfix for documentation changes.

pigeonflight · September 25, 2020, 10:32pm

No problem.