changelog/release notes

[davidszotten]

Thanks for getting the new release out!

What do you think about starting a change log/release notes document with an overview of changes since the previous release? Would be a big help and much easier than trying to diff commit logs

[bkjones]

That'd be cool. I actually need to have something to automate that based on github PRs or something. I'll look around for the tool. Maybe GH's MO is "if you want a changelog just read the PR history" :/

[davidszotten]

for our projects we just (manually) write a sentence or so when landing a pull request.

(btw, we typically got to a point where we wanted to add them, and finding the historical info was a pain, but rather than blocking on that we just started the changelog at whatever version was current at the time)

[bkjones]

+1 - good idea. I'll also add a 'CONTRIBUTORS' file so those who contribute also add themselves to that so they're automatically added when/if their pull request is merged.

[bkjones]

Hey @davidszotten - I just found that the 'Compare View' in github supports comparing tags and makes for a pretty much ready-made changelog. I'll still create a separate file for this to summarize & avoid some of the noise here, but figured I'd point it out to you anyway :)
v1.0.1...master

[davidszotten]

hi. i do know about that view; however, i find reading a few sentences specifically written to summarise changes much friendlier than trying to read tens of commit messages. i think they have different roles.

so a changelog will be much appreciated. thank you!

[bkjones]

@davidszotten - yup, totally agreed. I've started one - it's in the repo now, though I'd love a PR from someone who knows how to get GH to render the @name callouts when the file is being viewed from within github. The contributors file is also there now, and you're already in there (thanks again).

[deslum]

I fork and update module. Welcome https://github.com/deslum/pyrabbit2