Example of a changelog that could be used as template

JanStevens commented 5 years ago

Description

Adds an example changelog for documenting #101 so we have more uniform guidelines. I did follow https://keepachangelog.com/en/1.0.0/ as much as possible but removed the links at the bottom to have diffs between versions. Seems like a burden to maintain and you can easily do it yourself

Issues Resolved

101 more of an addition then resolved

Check List

[ ] All tests pass. See https://github.com/sous-chefs/apache2/blob/master/TESTING.md
[ ] New functionality includes testing.
[ ] New functionality has been documented in the README if applicable

JanStevens commented 5 years ago

Could we add the tree comparison links at the bottom of the changelog?

[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0

I really think thats a burden to maintain and not that useful at all

JohnRoesler commented 5 years ago

@JanStevens I suppose folks can just view the releases diffs - i'm good with leaving it out

sous-chefs / meta