-
Notifications
You must be signed in to change notification settings - Fork 2
Commit Logs
Mike Lee edited this page Aug 2, 2013
·
4 revisions
There is one type of information you should never put in your commit logs, and that is information that doesn't belong there.
This is a description of what has changed in this message, phrased as if it were the step in a recipe.
It is not a description of what the code should be doing. Instead, file an issue and reference that.
It should not contain a dissertation on the general problem. Put that in the wiki and link to it.
It should not contain the emotional artifacts of your day or your relationships.
It's just a short description, that's all. It should look like this:
Whip the cream Whip to stiff peaks.