Commiting in Launchpad: Guidelines

Hello everybody,

This message to depict our new policy in therms of commit and bugfixes into
Launchpad. As you are directly concerned, read carefully the following 4 points and don't hesitate to give feedback!


1. The stable branch must be used for bugfixes. Only bugfixes. The new
features (+the bugfixes on these new functionalities) have to be done in
the trunk branch. Note that we will backport periodically all the fixes
from stable to trunk.

2. Always set the author's name, if it's different from the committer. I
heard that some contributors have seen them work commited without at
least their name in the commit message: this is not acceptable at all.
We have to show respect for them and for their work, so please use
--author="" when merging work or patching features from
community.
e.g: bzr commit --author=""

3. Commit message format:
* Use header in each commit message. Header should be one of [IMP],
[FIX], [REF], [ADD], [REM].
[IMP] : For improvements
[FIX] : For bug fixes
[REF] : For refactoring (improvements of the source code, without
changing the functionalities or behavior. See
http://en.wikipedia.org/wiki/Refactoring for further details)
[ADD] : For adding new resources
[REM] : For removing of resources
* Always put meaning full commit message. Commit message should be self
explanatory including the name of the module that has been changed. No
more "bugfix" or "improvements" anymore! (the only single word commit
messgae accepted is "merge")
* If you are fixing the bugs use --fixes=lp: instead of
putting the number of the bug in the commit message.
* Use the revision id instead of the revision number when you make
reference to a revision in your commit message. You can get this
revision id, by using the command "bzr version-info".

e.g:
Not Correct : bzr commit -m “[FIX]: reverted bad revision (cannot
install new db) with revision number:525425”
Correct : bzr commit -m “[FIX]: reverted bad revision (cannot install
new db) with revision number id:
qdp@tinyerp.com-20090602143202-ehmntlift166mrnn”
Not Correct : bzr commit -m "Bug 568889 : typo corrected"
Correct : bzr commit --fixes=lp:568889 -m "[FIX] account module: typo
corrected"

4. Don't make commit that impacts lots of modules. Try to splits into
different commits where impacted modules are differents (It will be
helpful when we are going to revert that module separately).


Regards,