Release 0.4.0 preparation (#1078)v0.4.0dependencies/v0.4.0

1 files changed, 32 insertions, 29 deletions

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f4ea181..78088bd 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -38,23 +38,26 @@ in the Docsy user guide.
 These notes are WIP for creating a release (v0.X.Y) from a local copy of the
 repo.
 
-1.  Change directory to your local docsy repo and ensure that you're on a branch
+1.  Change directory to your local Docsy repo and ensure that you're on a branch
     and at the commit that you want to tag as the next release (usually
     `@HEAD`).
 2.  Ensure that the [CHANGELOG](CHANGELOG.md) has a release summary entry for
-    v0.X.Y. If not, create one with a brief summary of breaking changes. (Change
-    details are autogenerated by GitHub in a later step.)
-3. Update the Hugo module versions to v0.X.Y.
-4. Update the NPM package version in [package.json](package.json) to v0.X.Y.
-5.  Create the tags for v0.X.Y (we currently need two):
-
-    ```console
-    $ REL=v0.X.Y
-    $ git tag $REL
-    $ git tag dependencies/$REL
+    v0.X.Y. If not, create one with a brief summary of breaking changes using
+    the section template at the end of the file. (Note that change details are
+    autogenerated by GitHub in a later step.)
+3.  Update the Hugo module versions to v0.X.Y.
+4.  Update the NPM package version in [package.json](package.json) to 0.X.Y.
+5.  Commit your changes, usually as a PR entitled "Release v0.X.Y preparation".
+    Once the PR is approved and merged, proceed with the remaining steps.
+6.  Create the tags for v0.X.Y (we currently need two):
+
+    ```sh
+    REL=v0.X.Y
+    git tag $REL
+    git tag dependencies/$REL
     ```
 
-6.  Push the new tags to the main repo (which is named `upstream` in my setup)
+7.  Push the new tags to the main repo (which is named `upstream` in my setup)
     either one by one or all together provided you have no other new tags
     defined. The following illustrates the latter, and does a dry run first:
 
@@ -67,28 +70,28 @@ repo.
 
     If only the two new tags are listed, drop the dry-run flag to push the tags.
 
-5.  Use the GitHub [Draft a new release][] feature, filling in the fields as
+8.  Use the GitHub [Draft a new release][] feature, filling in the fields as
     follows:
 
-    - From the release/tag dropdown: Select the new release tag that you just
-      pushed, v0.X.Y.
-    - Set the release title to the release number (without the "v").
-    - Click "auto-generate release notes" to get the release details.
-    - Replace the auto-generated "## What's Changed" heading by the following:
+    -   From the **release/tag dropdown**: Select the new release tag that you just
+        pushed, v0.X.Y.
+    -   Set the **release title** to the release number (without the "v").
+    -   Click "auto-generate release notes" to get the release details.
+    -   Replace the auto-generated "## What's Changed" heading by the following:
 
-      ```markdown
-      ## Release summary
+        ```markdown
+        ## Release summary
 
-      See, https://github.com/google/docsy/blob/main/CHANGELOG.md#0XY
+        See, https://github.com/google/docsy/blob/main/CHANGELOG.md#0XY
 
-      ## Commit details
-      ```
+        ## Commit details
+        ```
 
-    - Replace the `0XY` anchor target above with a target appropriate for this
-      release.
-    - Remove the "New contributors" autogenerated text since we don't publish
-      that as part of our release notes.
-    - Select **Create a discussion for this release**.
-    - Click **Publish release**.
+    -   Replace the `0XY` anchor target above with a target appropriate for this
+        release.
+    -   Remove the "New contributors" autogenerated text since we don't publish
+        that as part of our release notes.
+    -   Select **Create a discussion for this release**.
+    -   Click **Publish release**.
 
 [draft a new release]: https://github.com/google/docsy/releases/new