Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOC] mention checking badges during release #4085

Merged
merged 1 commit into from
Oct 30, 2023
Merged

[DOC] mention checking badges during release #4085

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down
3 changes: 3 additions & 0 deletions doc/maintenance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down