This is reminder of part of our committing guidelines with Mercurial [1].

Both "hg log" command and the "hgweb" web interface print only
the first line of a commit message by default. So it's best to write a
commit message whose first line stands alone. Our recommendation is to
write short but informative messages that tells us something we can't
quickly figure out from the diff.

* Template for good commit messages:

-----------------
Short (72 chars or less) summary of changes.

More detailed explanatory text, if necessary.  Wrap it to about 72
characters or so. Leave a blank line between the summary and the
detailed explanation.

If needed, further paragraphs can come after:

  - Bullet points are fine.
  - Second bullet point.
-----------------

* Example of a good commit message:

-----------------
Fix issue 27183: make postcreate and postupdate stop on build errors

This ensures that importing masterdata and sampledata will not
fail because of this past error.
-----------------

* Example of a bad commit message:

-----------------
Fix issue 27183: make the postcreate and postupdate ant tasks stop the build 
process when errors are found. This is useful to ensure that importing 
masterdata and sampledata will not fail later on in the process. So changed the 
"onerror" paramater accordingly. Now that I'm writing, I'd also like to say 
hello to my friend John Doe.
-----------------



Thanks,

Juan Pablo


------------------------------------------------------------------------------
Open Source Business Conference (OSBC), March 24-25, 2009, San Francisco, CA
-OSBC tackles the biggest issue in open source: Open Sourcing the Enterprise
-Strategies to boost innovation and cut costs with open source participation
-Receive a $600 discount off the registration fee with the source code: SFAD
http://p.sf.net/sfu/XcvMzF8H
_______________________________________________
Openbravo-development mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/openbravo-development

Reply via email to