Changelog #118

Closed
gtd opened this Issue Jul 16, 2012 · 7 comments

Projects

None yet

2 participants

@gtd
Contributor
gtd commented Jul 16, 2012

Having one would be extremely useful for upgrades which terrify me a bit when it comes to Facebook.

@mmangino
Owner

The git log is your best changelog. Just look at the commit messages. That's always up to date.

@mmangino mmangino closed this Jul 16, 2012
@gtd
Contributor
gtd commented Jul 16, 2012

I disagree strongly with this on a philosophical level. A curated changelog is a tremendously useful tool for the majority of the user base who are not knee-deep in the code and may have quite a long span of versions to go through. This is quite painful to do on github and requires a clone to run git-log for long histories. Aside from that not every contributor follows best practices for git commit messages, so you might miss some good information, or there might be major refactorings that add noise to the git log.

Anyway, thats just my opinion and it's your project. However, if you do plan on using only git commit messages can I make a secondary request that you include version numbers in the gemspec bump commits?

@mmangino
Owner

Okay, if this is something you feel strongly about, I'll get it a try. I'll export the log and clean it up a bit to start with and then I'll try to keep it up going forward.

Mike

On Jul 16, 2012, at 1:58 PM, Gabe da Silveira reply@reply.github.com wrote:

I disagree strongly with this on a philosophical level. A curated changelog is a tremendously useful tool for the majority of the user base who are not knee-deep in the code and may have quite a long span of versions to go through. This is quite painful to do on github and requires a clone to run git-log for long histories. Aside from that not every contributor follows best practices for git commit messages, so you might miss some good information, or there might be major refactorings that add noise to the git log.

Anyway, thats just my opinion and it's your project. However, if you do plan on using only git commit messages can I make a secondary request that you include version numbers in the gemspec bump commits?


Reply to this email directly or view it on GitHub:
#118 (comment)

@gtd
Contributor
gtd commented Jul 17, 2012

Thanks Mike! I really have appreciated your work over the years. Been maintaining a FB app since 2007 and was very pleased when you took up Facebooker and we could finally get off rfacebook. Those were dark days.

@gtd
Contributor
gtd commented Mar 4, 2013

I'm set for another Mogli update and it's really hard to see what's changed. Even if the git log had the version numbers in the commit message instead of requiring looking at the diff that would be an improvement.

@mmangino
Owner
mmangino commented Mar 4, 2013

I appreciate what you're saying, but for me the amount of effort to keep that up is more than I am willing to spend. If you want to know what changes, you can look at this view: https://github.com/mmangino/mogli/commits/master

I always mark version changes with the same commit method.

@gtd
Contributor
gtd commented Mar 4, 2013

Clearly I'm aware of how to use git log. I thought changelog/history was standard practice for all open source, but if you're set in your workflows there's nothing more for me to say, except perhaps to suggest that you delete the changelog for tidiness sake.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment