From 96657cbf15ea191e6e37f4a76e11a1de107f5df3 Mon Sep 17 00:00:00 2001 From: Thomas VINCENT Date: Thu, 13 Jun 2024 15:51:27 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: payno --- CONTRIBUTING.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b4ca44340f..73260e4e3b 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -108,7 +108,7 @@ Automated tests - Run the `release workflow`_ manually (see `manually running a workflow`_) to check that the release artifacts are built correctly. The wheels generated by the workflow can be downloaded from the release workflow run web page. - Note: Running the workflow manually do NOT publish artifacts to pypi. + *Note: Running the workflow manually do NOT publish artifacts to pypi.* - Run the `previous release workflow`_ with the following variables: - ``REPOSITORY``: ``https://github.com//silx`` (default: ``https://github.com/silx-kit/silx``) @@ -127,7 +127,7 @@ Write the release notes - Generate the list of pull requests included in the release with github's automatically generated release notes (see `github automatically generated release notes`_) between a new tag and the previous release. - Copy the generated changelog to ``CHANGELOG.rst`` and close github's release web page. - Warning: DO NOT publish the release yet! + **Warning: DO NOT publish the release yet!** - Sort, curate and fix the list of PRs and match the styling of previous release notes. Steps @@ -144,7 +144,7 @@ Create the release .................. * Draft a new release from `github new release page`_ using similar conventions as previous releases: - - Create a new tag which MUST be named ``v`` and match the version in ``src/silx/_version.py``. + - Create a new tag which **MUST** be named ``v`` and match the version in ``src/silx/_version.py``. - Combine the release notes manually edited from ``CHANGELOG.rst`` with `github automatically generated release notes`_. * Press the "Publish release" button to trigger the release workflow which builds the documentation, the source tarball and the wheels.