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.

Sign up for GitHub

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

Add some tips about writing highlights in release docs #1352

Merged
merged 2 commits into from
Nov 28, 2022
Merged

Add some tips about writing highlights in release docs #1352

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b34f5d9
Update RELEASE.md
Janpot Nov 16, 2022
21554ed
Merge branch 'master' into release-notes
Janpot Nov 28, 2022
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
5 changes: 5 additions & 0 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@

1. Copy the generated changelog from the console, clean it up, add a short summary of the release highlights and use the new version number as the title.

Writing good highlights:

- Focus on new user facing features or changes
- Be concise, link to relevant documentation for extra clarity

1. Prepend the changelog to [`CHANGELOG.md`](./CHANGELOG.md).

1. Open a PR with the proposed changes.
Expand Down
Loading