This is for all RTT,KDL,BFL,OCL folks.
I'm noticing that the commit messages related to the bug tracking are quite
unreadable. For example: "Makes the CaptureCamera component work again with
RTT 1.4, applying patch 210 for bug 492".
That should be: "Fixes bug #492: Update CameraComponents to meet Component
Guidelines (attachment #210). Makes the CaptureCamera component work again
with RTT 1.4."
The rationale is this:
* Always start the message with the bug number info in front. The bug number
is formatted as "bug #%d", where %d is your number.
* Repeat the bug subject, when I'm looking at svn history, I'm not inclined to
look up every bug number in bugzilla, so do me a favour and copy/paste the
description. This is especially important when doing branch management.
* Finally, write a short sentence how you fixed the issue.
* It's not necessary to write down every filename you changed, as svn keeps
track of this for you.
If I recall correctly, Bugzilla 3.0 supports bugmail, which allows the svn
server to send messages to bugzilla when it receives a commit with
a '#number' in it. Using this would save you updating the bug report in
Bugzilla. Maybe the PMA people can look at how they can configure their svn
server to do this ? The above syntax is maybe not correct enough for this
system... The Debian project for example uses 'closes: #number' instead
of 'Fixes: #number'.
Peter
Commit messages guidelines & Bugzilla
On Tuesday January 22 2008 18:23:55 Peter Soetens wrote:
> This is for all RTT,KDL,BFL,OCL folks.
> I'm noticing that the commit messages related to the bug tracking are quite
> unreadable. For example: "Makes the CaptureCamera component work again
> with RTT 1.4, applying patch 210 for bug 492".
>
> That should be: "Fixes bug #492: Update CameraComponents to meet Component
> Guidelines (attachment #210). Makes the CaptureCamera component work again
> with RTT 1.4."
>
> The rationale is this:
> * Always start the message with the bug number info in front. The bug
> number is formatted as "bug #%d", where %d is your number.
> * Repeat the bug subject, when I'm looking at svn history, I'm not inclined
> to look up every bug number in bugzilla, so do me a favour and copy/paste
> the description. This is especially important when doing branch management.
> * Finally, write a short sentence how you fixed the issue.
> * It's not necessary to write down every filename you changed, as svn keeps
> track of this for you.
>
> If I recall correctly, Bugzilla 3.0 supports bugmail, which allows the svn
> server to send messages to bugzilla when it receives a commit with
> a '#number' in it. Using this would save you updating the bug report in
> Bugzilla. Maybe the PMA people can look at how they can configure their svn
> server to do this ? The above syntax is maybe not correct enough for this
> system... The Debian project for example uses 'closes: #number' instead
> of 'Fixes: #number'.
I suggest that all these guidelines about commit messages and patches
and coding style and improving the code and components and ... is
collected on a orocos.org page because apparently it is important to
some of us but scattered all over the mailinglist(s). I can't see the
trees anymore.
Ruben
> Peter
> --
> Peter Soetens -- FMTC --
bugzilla
Hi,
I think that bugzilla should be updated to the orocos-toolchain
infrastructure. Now, it seems that _only_ you can put bugs to 1.x.
Or maybe you think that orocos-toolchain 2.x is so perfect that no bugzilla is
needed? ;-)
Leo
bugzilla
On Friday 08 October 2010 10:49:44 Leopold Palomo-Avellaneda wrote:
> Hi,
>
> I think that bugzilla should be updated to the orocos-toolchain
> infrastructure. Now, it seems that _only_ you can put bugs to 1.x.
>
> Or maybe you think that orocos-toolchain 2.x is so perfect that no bugzilla
> is needed? ;-)
Thanks for poking. I have added the Toolchain product with its versions.
Peter