oship-dev team mailing list archive

[Diego Manhães Pinheiro <dmpinheiro@xxxxxxxxx>]

Hi all !


Every time that a commit solves a bug found at launchpad bug report system,
is a excellent recommendation use the bazaar --fixes command option[] during
the commit action. It marks a commit as a code change that solves a bug.
This relationship definition helps a lot to maintain the traceabilty of
which revision certain bug was solved. In addition to this option, is
interesting put the bug number reference in the commit message, using the
pattern #[0-9]+ (pound sign plus number).
Another situation is always try to keep the relation 1 bug - 1 commit. It's
not a good practice use the relation X bugs - 1 commit. I did the last one
in my lastest commits, but I'm know this not a good practice. Use the
relation 1 bug, X commit is acceptable of course, but don't forget mark the
last code commit that solves the bug.
If any moment you don't found a better solution to separate each bug with a
commit, put all bug references in the commit message at least. Commit
messages do this job as well. Try to use word such as fixed, fixes, close or
close that helps understand which bug is related.
Try also write good messages. When we this milestone was done, some commit
messages will be used as a ChangeLog to the release. If I found any weird
message, it will be discarded, and will generate more work to understand
which problem was solved.


Cheers


-- 
http://dmpinheiro.net
-----------------------------------
Diego Manhães Pinheiro