Skip to content

Commit

Permalink
Document steps to format release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
seancolsen committed Jan 31, 2024
1 parent ad1e0e0 commit 68d7bb9
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/docs/releases/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,21 @@ This is developer documentation to help with release notes. It is not published

1. Re-run the script as needed. When more PRs are merged, they will appear in `missing_prs.csv`.

## How to format the release notes content

1. Group changes into sections in the following order

```md
## Security fixes
## Breaking changes
## New features
## Groundwork
## Documentation
## Bug fixes
## Maintenance
```

You can omit sections if there are no applicable changes.

1. Within the "New features" section, further categorize changes by specific features using level 3 headings.

0 comments on commit 68d7bb9

Please sign in to comment.