From bdacd01b461e327974d9695df19af10a6336130c Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Wed, 8 Nov 2023 19:50:51 -0500 Subject: [PATCH] Misc updates to CONTRIBUTING.md (#1714) --- CONTRIBUTING.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c1961097dc..5ad5444d76 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,7 +60,7 @@ repo. 6. **Pull in `main`** to get the last PR. 7. **Ensure** that you're: - On the default branch, `main` - - At the commit that you want to tag as the next release (usually `@HEAD`). + - At the commit that you want to tag as v0.X.Y 8. **Create tags** for v0.X.Y (we currently need two): ```sh @@ -69,8 +69,8 @@ repo. git tag dependencies/$REL ``` -9. **Push the new tags** to the main repo (which is named `upstream` in the - following setup): +9. **Push the new tags** to the main repo, which is named `upstream` in the + following example: ```console $ git push upstream $REL && git push upstream dependencies/$REL @@ -84,19 +84,17 @@ repo. - 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: + - Click **Generate release notes** to get the release details inserted into + the release notes text area. + - Add the following text atop the generated release notes, but replace the + `0XY` anchor target with a target appropriate for this release: ```markdown ## Release summary See, https://github.com/google/docsy/blob/main/CHANGELOG.md#0XY - - ## Commit details ``` - - Replace the `0XY` anchor target above with a target appropriate for this - release. - Remove the "New contributors" autogenerated text (if present) since we don't publish that as part of our release notes. - Select **Create a discussion for this release**.