-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add semver information and CHANGELOG (#56)
Background To make sure people can better rely on us and to prepare for the new golang package management system we need to start to be more serious about versioning. It was therefore decided to start relying on [Semver](https://www.semver.org). This PR introduces an update to the README containing information about how we deal with releases and also introduces a CHANGELOG.md that can be used to keep track of versions. It was decided to start on V1.0 since this is used in production. Discussions can be found in issue #48 Changes - Update README.md to include link to CHANGELOG.md - Update README.md to include information about semver - Add CHANGELOG.md for changelog related info
- Loading branch information
Showing
3 changed files
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
Background | ||
*MANDATORY* | ||
Describe *WHY* this change is being made, be clear, | ||
use proper English and don't write lines longer than 80 chars. | ||
|
||
Caveats | ||
*OPTIONAL* | ||
Discuss any caveats your code may contain, remove if not needed. | ||
|
||
Changes | ||
*MANDATORY* | ||
- List your major changes one by one | ||
|
||
Checklist | ||
- [ ] Tests added | ||
- [ ] Documentation updated to include changes (if needed) | ||
- [ ] Gofmt run on your code |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Changelog | ||
All notable changes to this project will be documented in this file. | ||
|
||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
||
## [1.0.0] - 2018-10-30 | ||
|
||
### Added | ||
- This CHANGELOG file to hopefully serve as an evolving example of a | ||
standardized open source project CHANGELOG. | ||
- Enforcing Semver compatability in releases | ||
|
||
### Changed | ||
- Update README.md to include information about release strategy | ||
- Update README.md to link to CHANGELOG.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters