On Tue, Apr 14, 2009 at 06:24:30PM +1000, Peter Becker wrote: > > Very good point. I notice this difference a lot in commit messages: > quite often they are written in a way that is entirely redundant with > the diff you get. That might make sense for large commits (kind of like > an executive summary), but I've seen micro-commits with messages written > that way. What I'd really like to read is an answer to the question "why > did you change this?", I can see what has changed much more accurately > in the diff. Unfortunately most people tend to document the What, but > not the Why. I'm not sure if that's part of human nature or just a > (sub-)cultural thing.
Nothing to add but "Hear! Hear!". I wish more people followed this advice. But even after telling people so many times, it's still difficult to get people to write down why a change was made. -Dom --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "The Java Posse" group. To post to this group, send email to javaposse@googlegroups.com To unsubscribe from this group, send email to javaposse+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/javaposse?hl=en -~----------~----~----~----~------~----~------~--~---
