DOC: Add "performance" category to the release notes

pmli · Nov 10, 2020 · 399e916 · 399e916
1 parent 17cd07f
commit 399e916
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/...se/upcoming_changes/13516.improvement.rst → ...se/upcoming_changes/13516.performance.rst b/...se/upcoming_changes/13516.improvement.rst → ...se/upcoming_changes/13516.performance.rst
diff --git a/doc/release/upcoming_changes/README.rst b/doc/release/upcoming_changes/README.rst
@@ -21,11 +21,17 @@ Each file should be named like ``<PULL REQUEST>.<TYPE>.rst``, where
   backwards compatible. (Not to be used for removal of deprecated features.)
 * ``c_api``: Changes in the Numpy C-API exported functions
 * ``new_feature``: New user facing features like ``kwargs``.
-* ``improvement``: Performance and edge-case changes
+* ``improvement``: General improvements and edge-case changes which are
+  not new features or compatibility related.
+* ``performance``: Performance changes that should not affect other behaviour.
 * ``change``: Other changes
 * ``highlight``: Adds a highlight bullet point to use as a possibly highlight
   of the release.
 
+It is possible to add two files with different categories (and text) if both
+are relevant. For example a change may improve performance but have some
+compatibility concerns.
+
 Most categories should be formatted as paragraphs with a heading.
 So for example: ``123.new_feature.rst`` would have the content::
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -64,6 +64,11 @@ requires = [
         name = "Improvements"
         showcontent = true
 
+    [[tool.towncrier.type]]
+        directory = "performance"
+        name = "Performance improvements and changes"
+        showcontent = true
+
     [[tool.towncrier.type]]
         directory = "change"
         name = "Changes"