Create a Changelog
Summary
Create a CHANGELOG.md in root
Motivation
Customers can be informed with this about breaking changes and new features.
Detailed Design
I would suggest to manaage the CHANGELOG.md manually because I have bad experience with automated CHANGELOG.mds and also automated ones are mostly less readable for humans and are more like a commit history. 🙁
Also if we want to, we can put some humor into messages and therefore bind a happy community.
Documentation
Not needed.
Drawbacks
More effort needed before releasing a new version.
Alternatives
None.
Open Questions
Any questions?
Help Needed
Don't think so.
Frequently Asked Questions
Currently none
Related Discussions
Currently none
Create a Changelog
Summary
Create a CHANGELOG.md in root
Motivation
Customers can be informed with this about breaking changes and new features.
Detailed Design
I would suggest to manaage the CHANGELOG.md manually because I have bad experience with automated
CHANGELOG.mds and also automated ones are mostly less readable for humans and are more like a commit history. 🙁Also if we want to, we can put some humor into messages and therefore bind a happy community.
Documentation
Not needed.
Drawbacks
More effort needed before releasing a new version.
Alternatives
None.
Open Questions
Any questions?
Help Needed
Don't think so.
Frequently Asked Questions
Currently none
Related Discussions
Currently none