Mercurial > pylearn
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 1310:f5e9c00a67d7 | 1311:431d0db69499 |
|---|---|
| 388 - The size of the first line does not really matter (although keeping it | 388 - The size of the first line does not really matter (although keeping it |
| 389 short is better, it is not truncated when you do 'hg log') | 389 short is better, it is not truncated when you do 'hg log') |
| 390 - The fetch commit message is like "Automated merge with | 390 - The fetch commit message is like "Automated merge with |
| 391 https://theanoclone.googlecode.com/hg/". It is too long to ask people to | 391 https://theanoclone.googlecode.com/hg/". It is too long to ask people to |
| 392 use the same. I guess "Merge" would be the most logical message to use. | 392 use the same. I guess "Merge" would be the most logical message to use. |
| 393 | 393 |
| 394 FB: The proposed guide line | |
| 395 * A one line summary | |
| 396 * If needed a blanc line followed by a more detailed summary | |
| 397 * Make a commit for each logical modification | |
| 398 * This make review easier to do | |
| 399 * This make debugging easier as we can more easily pinpint error in commit with hg bisect | |
| 400 * NEVER commit reformating change with functionality | |
| 401 * HG RECORD/DIFF are your friend | |
| 402 * hg record allow you to record select the change to a file to commit | |
| 403 * hg record force you to review your code! | |
| 404 * Review your code before commit | |
| 405 * Stuff from django guide | |
| 406 * Write detailed commit messages in the past tense, not present tense. | |
| 407 * Good: "Fixed Unicode bug in RSS API." | |
| 408 * Bad: "Fixes Unicode bug in RSS API." | |
| 409 * Bad: "Fixing Unicode bug in RSS API." | |
| 410 * Separate bug fixes from feature changes. | |
| 411 * ? If fix a ticket, make the message start with "Fixed #abc" | |
| 412 * Can make a system to change the ticket? | |
| 413 * ? If reference a ticket, make the message start with "Refs #abc" | |
| 414 * Can make a system to put a comment to the ticket? | |
| 415 | |
| 416 | |
| 394 Tools to help us out | 417 Tools to help us out |
| 395 --------------------- | 418 --------------------- |
| 396 | 419 |
| 397 Dumi: | 420 Dumi: |
| 398 | 421 |