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.

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

Misc updates to CONTRIBUTING.md #1714

Merged
merged 1 commit into from
Nov 9, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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**.
Expand Down
Loading