Document towncrier in the README

readthedocs · Mar 28, 2023 · 861b8e0 · 861b8e0
1 parent 5fa927c
commit 861b8e0
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -127,6 +127,16 @@ You can even get black to format changes automatically when you commit using `pr
     pip install pre-commit
     pre-commit install
 
+Release Notes
+~~~~~~~~~~~~~
+
+Release notes are managed through `towncrier <https://towncrier.readthedocs.io/en/stable/index.html>`_.
+When making a pull request you will need to create a news fragment to document your change:
+
+.. code-block:: bash
+
+    tox -e release_notes -- create --help
+
 Versioning
 ----------