Whenever you release a new version, please tag it in git. For example:
git tag -a v1.0.0 -m "Release 1.0.0"
git push --tags
This will automatically create a new Release on GitHub, which you can then add Release Notes to. GitHub provides a nice editor for releases. Here is an example:
https://github.com/octokit/octokit.rb/releases
Each release that is not backwards-compatible MUST contain an upgrade guide. Here's a good example:
Whenever you release a new version, please tag it in git. For example:
This will automatically create a new Release on GitHub, which you can then add Release Notes to. GitHub provides a nice editor for releases. Here is an example: https://github.com/octokit/octokit.rb/releases
Each release that is not backwards-compatible MUST contain an upgrade guide. Here's a good example:
https://github.com/octokit/octokit.rb#upgrading-guide