search

albrow / jobs

A persistent and flexible background jobs library for go.
MIT License
499 stars 47 forks source link

Add a changelog #23

Closed epelc closed 9 years ago

epelc commented 9 years ago

I think it'd be nice if there was a changelog. This can either be done by hand or it can be automated if you force a syntax for commits ie changeType(component): msg. For an example of an automated changelog take a look at the angular-material project. Their changelog is generated by the commit messages and then I think they tweak any problems with it before a release. That might be a bit much for this project but it let's you know what can be done. Either way I think a basic changelog would be really nice.

@albrow What do you think about this? I think it'd definitely make this easier to use in production.

albrow commented 9 years ago

@epelc I agree that this is important. I've already been posting release notes and a changelog for every release on the releases page. Whenever there are non-trivial breaking changes, I'll probably publish a migration guide, just like I have been doing with zoom. I'll add a link to the README to make this easier to find.

epelc commented 9 years ago

I forgot to check that. 9 times out of 10 no one fills It out. That's exactly what I was look for though.