Developers:
Friend to friend: When you make a release please take a few minutes to make a human-readable changelog of what has changed since the last release?
Your commit-messages are not a changelog.
Let me re-iterate:
Your commit-messages are _not_ a changelog.
A changelog allows me to follow what you were thinking between releases.
A commit log shows me your keystrokes between releases.
I need to know what you were thinking.
Thank you.
@craigmaloney @TheDoctor We use towncrier to build news fragments to publish public-readable release notes https://github.com/hawkowl/towncrier
@craigmaloney @TheDoctor Hmm...
Are change logs and release notes the same thing or somewhat different ?
I may be confusing terminology on my end with what you are looking for.
@superruserr @TheDoctor Was in part because the release notes are under NEWS and not where I thought they would be.
Each time a change is made in a PR, you add a newsfile like below describing the change made in the PR:
PR_ID.ignore if the change is minor and not worth reading in the public space. ie a change involving fixing newlines.
PR_ID.bugfix if the change is a bugfix.
PR_ID.feature if it's an added feature.
PR_ID.remove if something is taken away
And so on.
Then when a release is made towncrier collates them all into one document, or concatenates on top of existing release notes.
@superruserr Ah, very cool. Thanks for pointing me to this.
@superruserr @TheDoctor slight irony that the project doesn't have a file called Changelog.