18.7 How to structure your NEWS
file
- Use a top level heading for each version, most recent at top
- Each change should be in a bulleted list
- If lots of changes, use a subheading to break it up
- If related to a github issue, include pull request number and user name
e.g.:
# foofy (development version)
* Better error message when grooving an invalid grobble (#206).
# foofy 1.0.0
## Major changes
* Can now work with all grooveable grobbles!
## Minor improvements and bug fixes
* Printing scrobbles no longer errors (@githubusername, #100).
* Wibbles are now 55% less jibbly (#200).