Document news fragment type in contributing guide (#522)

* Document our news fragment types in CONTRIBUTING.rst * Add news fragment * spell out * Update CONTRIBUTING.rst Co-authored-by: Adi Roiban <adi.roiban@chevah.com> * Remove other please, too --------- Co-authored-by: Adi Roiban <adi.roiban@chevah.com>
twisted · Jun 13, 2023 · 2be422e · 2be422e
1 parent 49a6cba
commit 2be422e
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -66,10 +66,20 @@ We recommend the following workflow:
       *Running the test suite* for details.
 
    c. Document any user-facing changes in one of the ``/docs/`` files.
-      Please use `one sentence per line`_.
+      Use `one sentence per line`_.
 
-   d. Create a newsfragment in ``src/towncrier/newsfragments/`` describing the changes and containing information that is of interest to end-users.
-      Please use `one sentence per line`_ here, too.
+   d. Create a news fragment in ``src/towncrier/newsfragments/`` describing the changes and containing information that is of interest to end-users.
+      Use `one sentence per line`_ here, too.
+      You can use the ``towncrier`` CLI to create them; for example ``towncrier create 1234.bugfix``
+
+      Use one of the following types:
+
+      - ``feature`` for new features
+      - ``bugfix`` for bugfixes
+      - ``doc`` for improvements to documentation
+      - ``removal`` for deprecations and removals
+      - ``misc`` for everything else that is linked but not shown in our ``NEWS.rst`` file.
+        Use this for pull requests that don't affect end-users and leave them empty.
 
    e. Create a `pull request`_.
       Describe in the pull request what you did and why.

diff --git a/src/towncrier/newsfragments/522.misc b/src/towncrier/newsfragments/522.misc