The "why" associated with a commit is so very valuable to anyone trying to get to grips with a project's source code.
2009/5/29 Simon Laws <[email protected]>: > I've noticed over the last couple of months that we have, on some > occasions, become a little lax about adding the "why" alongside the > "what" in our commit comments. Particularly problematic when there is > no JIRA to refer to. I'm as much a culprit as anyone else so I'm not > throwing rocks here but it would be useful to me if, as we're > reviewing each others changes, we can call out when we think the > comment isn't sufficient or clear enough so that the justification can > be updated and it becomes a matter of record. I seems that there are > some innovative discussions firing up on 2.x and it would be good to > be able to help people follow the twists and turns as best we can. > > Is this a fair observation? > > Simon >
