Mercurial > pylearn
diff doc/v2_planning/coding_style.txt @ 1311:431d0db69499
added info about the commit message.
author | Frederic Bastien <nouiz@nouiz.org> |
---|---|
date | Wed, 06 Oct 2010 10:39:54 -0400 |
parents | ef0f3deead94 |
children | 56278ca00b4d |
line wrap: on
line diff
--- a/doc/v2_planning/coding_style.txt Tue Oct 05 12:31:36 2010 -0400 +++ b/doc/v2_planning/coding_style.txt Wed Oct 06 10:39:54 2010 -0400 @@ -390,7 +390,30 @@ - The fetch commit message is like "Automated merge with https://theanoclone.googlecode.com/hg/". It is too long to ask people to use the same. I guess "Merge" would be the most logical message to use. - + +FB: The proposed guide line + * A one line summary + * If needed a blanc line followed by a more detailed summary + * Make a commit for each logical modification + * This make review easier to do + * This make debugging easier as we can more easily pinpint error in commit with hg bisect + * NEVER commit reformating change with functionality + * HG RECORD/DIFF are your friend + * hg record allow you to record select the change to a file to commit + * hg record force you to review your code! + * Review your code before commit + * Stuff from django guide + * Write detailed commit messages in the past tense, not present tense. + * Good: "Fixed Unicode bug in RSS API." + * Bad: "Fixes Unicode bug in RSS API." + * Bad: "Fixing Unicode bug in RSS API." + * Separate bug fixes from feature changes. + * ? If fix a ticket, make the message start with "Fixed #abc" + * Can make a system to change the ticket? + * ? If reference a ticket, make the message start with "Refs #abc" + * Can make a system to put a comment to the ticket? + + Tools to help us out ---------------------