Commit 19d5f14b authored by Joseph Weston's avatar Joseph Weston

add release instructions for how to update the changelog

parent ccb24707
......@@ -2,6 +2,22 @@
## Ensure that all tests pass
## Update the changelog
Change the top `unreleased` line to the new version number and add the date, e.g.
```
## [1.2.5] - 2019-11-11
```
Add a new `unreleased` line to the top of the changelog, e.g.
```
## [unreleased]
## [1.2.5] - 2019-11-11
```
## Tag the release
Make an **annotated** tag for the release. The tag must be the version number prefixed by the letter 'v':
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment