Release notes
Write release notes for the people who use the product.
- Find the two versions. If the user does not give them, use the last two git tags.
- Read the commits and the merged pull requests between the two versions.
- Put each change in one of three groups: New, Changed, Fixed.
- Write each change as one sentence that a user can understand. Do not write internal names, file paths, or commit hashes.
- Leave out the changes that a user cannot see, such as refactoring and changes to tests.
- Start with the version number and the release date.