diff --git a/docs/release.md b/docs/release.md index 679c38d..fed8d7e 100644 --- a/docs/release.md +++ b/docs/release.md @@ -13,20 +13,16 @@ 1. [Create a new release](https://github.com/asasine/BehaviorTree.NET/releases/new) - Tag version: `vMAJOR.MINOR.PATCH` targeting `main` (whatever version was decided above, with `v` prefix) - Title: `vMAJOR.MINOR.PATCH` - - Description: - - Should have a single H1: `vMAJOR.MINOR.PATCH (YYYY-MM-DD)` - - Can have a small paragraph after the H1 (e.g., a summary, link to a blog post) - - Should have various H2 (omit an H2 if it would be empty): + - Description: use the `Auto-generate release notes` button. + - Add a single H1: `vMAJOR.MINOR.PATCH (YYYY-MM-DD)` + - Can have a small paragraph after the H1 (e.g., a summary, link to a blog post, etc.) + - Can have categorized H2 (omit an H2 if it would be empty), or a general `What's Changed` H2. Examples of categories: - New Features - Bug Fixes - Internal - Use an unordered list under each H2 - - Each list item should have the format `#PR/#Issue Past tense description (@user)` - - `#PR/#Issue` uses the PR or Issue number from the change. - - `Past tense description` should begin with one of: - - Added - - Changed - - Fixed - - Removed - - `@user` is the GitHub username of the person who made the change. + - Each list item should have the format `{PR or Issue title} by @{user} {link}` + - `{PR or Issue title}` is the title from the PR or Issue that was merged or closed. + - `{user}` is the GitHub username of the person who made the change. + - `{link}` is the URL of the PR or Issue. - Check `This is a pre-release` if `version < 1.0.0` or there's a pre-release suffix on the version (e.g., `0.1.1` or `1.4.2-alpha`)