Simplify release guide slightly

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
pyxem · Mar 14, 2023 · e237eb0 · e237eb0
1 parent 904997f
commit e237eb0
Showing 1 changed file with 21 additions and 5 deletions.
diff --git a/RELEASE.rst b/RELEASE.rst
@@ -4,6 +4,11 @@ How to make a new release of ``kikuchipy``
 kikuchipy's branching model is similar to the Gitflow Workflow (`original blog post
 <https://nvie.com/posts/a-successful-git-branching-model/>`_).
 
+kikuchipy versioning adheres to `Semantic Versioning
+<https://semver.org/spec/v2.0.0.html>`__.
+See the `Python Enhancement Proposal (PEP) 440 <https://peps.python.org/pep-0440/>`__
+for supported version identifiers.
+
 Preparation
 -----------
 - If a minor release is to be made, create a release branch named e.g.
@@ -15,18 +20,22 @@ Preparation
   directly on the bug fix branch, so that no separate patch release branch has to be
   made.
   The bug fix branch should of course be branched off of ``main``.
+
 - Run all user guide notebooks locally and confirm that they produce the expected
   results.
+
 - Review the contributor list ``__credits__`` in ``release.py`` to ensure all
   contributors are included and sorted correctly.
   Do the same for the Zenodo contributors file ``.zenodo.json``.
   Review ``.all-contributorsrc`` and regenerate the table if necessary.
+
 - Increment the version number in ``release.py``.
   Review and clean up ``CHANGELOG.rst`` as per Keep a Changelog.
+
 - Make a PR of the release branch to ``main``.
   Discuss the changelog with others, and make any changes *directly* to the release
   branch.
-  Merge the branch onto ``main``.
+  Merge the branch into ``main``.
 
 Release (and tag)
 -----------------
@@ -38,23 +47,30 @@ Release (and tag)
   The release body contains a static description and a link to the changelog.
   This release draft can be published as is, or changes to the release body can be made
   before publishing.
+
 - Monitor the publish GitHub Action to ensure the release is successfully published to
   PyPI.
 
 Post-release action
 -------------------
 - Monitor the `documentation build <https://readthedocs.org/projects/kikuchipy/builds>`_
   to make sure the new stable documentation is successfully built from the release.
+
 - Ensure that `Zenodo <https://doi.org/10.5281/zenodo.3597646>`_ received the new
   release.
+
 - Ensure that Binder can run the user guide notebooks by clicking the Binder badges in
   the top banner of one of the user guide notebooks via `Read The Docs
   <https://kikuchipy.org/en/stable>`_.
-- Bring changes on ``main`` onto ``develop`` by branching off of ``main``, merge
-  ``develop`` onto the new branch, fix conflicts, and make a PR to ``develop``.
-- Make a post-release PR to ``develop`` with ``__version__`` updated (or reverted), e.g.
-  from "0.42.0" to "0.43.dev0", and any updates to this guide if necessary.
+
+- Bring changes in ``main`` into ``develop`` by first branching from ``main``, merge
+  ``develop`` into the new branch and fix conflicts.
+  After these conflicts are fixed, update or revert ``__version__`` and make any updates
+  to this guide if necessary.
+  Make a PR to ``develop`` and merge.
+
 - Tidy up GitHub issues and close the corresponding milestone.
+
 - A PR to the conda-forge feedstock will be created by the conda-forge bot.
   Follow the relevant instructions from the conda-forge documentation on updating
   packages, as well as the instructions in the PR.