mention checking badges during release

nilearn · Oct 27, 2023 · 99ce6bf · 99ce6bf
1 parent 5d32855
commit 99ce6bf
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -271,10 +271,12 @@ Other tags can describe the PR content : [FIX] for a bugfix, [DOC] for a
 change in documentation or examples, [ENH] for a new feature and [MAINT] for
 maintenance changes.
 
+.. _changelog:
+
 Changelog
 ---------
 
-Changelog entries in ``doc/changes/latest.rst`` should adhere to the following conventions:
+Changelog entries in ``nilearn/doc/changes/latest.rst`` should adhere to the following conventions:
 
 - Entry in the appropriate category
 - Single line per entry
@@ -294,7 +296,7 @@ List of badges:
       :bdg-danger:`Deprecation`
       :bdg-dark:`Code`
 
-Example entry in ``doc/changes/latest.rst``:
+Example entry in ``nilearn/doc/changes/latest.rst``:
 
 .. code-block:: rst
 

diff --git a/doc/maintenance.rst b/doc/maintenance.rst
@@ -181,6 +181,9 @@ Finally, we need to change the title from ``x.y.z.dev`` to ``x.y.z``:
    - Nilearn now includes functionality A
    - ...
 
+We must also ensure that every entry in ``nilearn/doc/changes/latest.rst``
+starts with a "badge" (see the :ref:`changelog` section).
+
 Once we have made all the necessary changes to ``nilearn/doc/changes/latest.rst``, we should rename it into ``nilearn/doc/changes/x.y.z.rst``, where ``x.y.z`` is the corresponding version number.
 
 We then need to update ``nilearn/doc/changes/whats_new.rst`` and replace: