Home » Eclipse Projects » Buckminster dev » Check-in comments
| Check-in comments [message #479211] |
Mon, 10 August 2009 05:57  |
Eclipse User |
|
|
|
Hi,
I would like us to unify our check-in comments. I know that many projects use comments similar to this one:
Bug 283104 - Qualifier replacement disabled when keyword 'qualifier' is prefixed
i.e. the relevant bugzilla number and its heading. I've been using this style too lately. This comment style makes it
very easy to create list of what's changed since the last release and it's also very easy to bring up information about
the actual bug, should the need arise. Entering the full URL clobbers the real information IMO and everyone knows where
to find the bugzilla anyway.
Moving forward, I'd like all our check-ins to have a comment like this unless the change is so trivial that no bugzilla
was ever entered.
What do others think about this idea?
Regards,
Thomas Hallgren
|
|
| | |
| Re: Check-in comments [message #479243 is a reply to message #479211] |
Mon, 10 August 2009 08:47  |
| Eclipse User |
|
|
|
+1
I've been using this kind of comment policy successfully in my own projects
for quite some time now. Browsing SVN history will then very easily point
you to the rationale behind this or that change others (or even you) made
months or years ago.
In a similar vein, I'd like to ask what others think about mentioning the
bugzilla number in inline code comments, too. That's not always appropriate,
of course. A huge new feature: no. A seemingly inconspicuous "if"-statement
to prevent a MysteriousMoonPhaseException later on, as reported by a user
from Alpha Centauri: yes.
Personally, I like the fact that I can simply CTRL-click the number and
Mylyn (if configured) opens the appropriate issue. Even without Mylyn, I
think the indication of _why_ a certain piece of code looks the way it is
helps other people understand the code base.
Cheers,
Achim
Thomas Hallgren wrote:
> Hi,
> I would like us to unify our check-in comments. I know that many projects
> use comments similar to this one:
>
> Bug 283104 - Qualifier replacement disabled when keyword 'qualifier' is
> prefixed
>
> i.e. the relevant bugzilla number and its heading. I've been using this
> style too lately. This comment style makes it very easy to create list of
> what's changed since the last release and it's also very easy to bring up
> information about the actual bug, should the need arise. Entering the full
> URL clobbers the real information IMO and everyone knows where to find the
> bugzilla anyway.
>
> Moving forward, I'd like all our check-ins to have a comment like this
> unless the change is so trivial that no bugzilla was ever entered.
>
> What do others think about this idea?
>
> Regards,
> Thomas Hallgren
|
|
| | |
| Re: [buckminster-dev] Check-in comments [message #479261 is a reply to message #479211] |
Mon, 10 August 2009 09:23 |
| Eclipse User |
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type">
</head>
<body bgcolor="#ffffff" text="#000000">
+1<br>
<br>
Karel<br>
<br>
<br>
Thomas Hallgren napsal(a):
<blockquote cite="mid:h5oqun$vaf$1@build.eclipse.org" type="cite">Hi,
<br>
I would like us to unify our check-in comments. I know that many
projects use comments similar to this one:
<br>
<br>
Bug 283104 - Qualifier replacement disabled when keyword 'qualifier'
is prefixed
<br>
<br>
i.e. the relevant bugzilla number and its heading. I've been using this
style too lately. This comment style makes it very easy to create list
of what's changed since the last release and it's also very easy to
bring up information about the actual bug, should the need arise.
Entering the full URL clobbers the real information IMO and everyone
knows where to find the bugzilla anyway.
<br>
<br>
Moving forward, I'd like all our check-ins to have a comment like this
unless the change is so trivial that no bugzilla was ever entered.
<br>
<br>
What do others think about this idea?
<br>
<br>
Regards,
<br>
Thomas Hallgren
<br>
<br>
_______________________________________________
<br>
buckminster-dev mailing list
<br>
<a class="moz-txt-link-abbreviated" href="mailto:buckminster-dev@eclipse.org">buckminster-dev@eclipse.org</a>
<br>
<a class="moz-txt-link-freetext" href="https://dev.eclipse.org/mailman/listinfo/buckminster-dev">https://dev.eclipse.org/mailman/listinfo/buckminster-dev</a>
<br>
</blockquote>
<br>
<div class="moz-signature">-- <br>
<style type="text/css">
..delimiter {
font-size: 11px;
font-weight: bold;
color:#007E00;
font-family: Geneva;
}
</style>
<span
style="font-family: Helvetica,Verdana,Arial; font-size: 9pt; color: rgb(103, 103, 103);">Karel
Brezina<span class="delimiter"> | </span><a class="moz-txt-link-abbreviated" href="mailto:karel.brezina@cloudsmith.com">karel.brezina@cloudsmith.com</a><span
class="delimiter"> | </span>+420.732.781459<span class="delimiter"> | </span>skype:
karel.brezina</span><br>
<span
style="font-family: Geneva; font-size: 11pt; color: rgb(19, 149, 214); font-weight: bold;">CLOUDSMITH<span
class="delimiter"> | </span><span
style="font-size: 9pt; color: rgb(103, 103, 103); font-weight: normal; font-family: Helvetica;">Czech
Republic</span></span>
</div>
</body>
</html>
|
|
| |
| Re: [buckminster-dev] Check-in comments [message #479276 is a reply to message #479261] |
Mon, 10 August 2009 10:10 |
| Eclipse User |
|
|
|
This is a multi-part message in MIME format.
--------------030509040305090509080306
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
+1
For EMF we always use [<bugzilla-id>] <rest of comment>
This lets us generate release notes for each build automatically... We
can even resolve these bugs automatically after the build picks them up.
Karel Brezina wrote:
> +1
>
> Karel
>
>
> Thomas Hallgren napsal(a):
>> Hi,
>> I would like us to unify our check-in comments. I know that many
>> projects use comments similar to this one:
>>
>> Bug 283104 - Qualifier replacement disabled when keyword
>> 'qualifier' is prefixed
>>
>> i.e. the relevant bugzilla number and its heading. I've been using
>> this style too lately. This comment style makes it very easy to
>> create list of what's changed since the last release and it's also
>> very easy to bring up information about the actual bug, should the
>> need arise. Entering the full URL clobbers the real information IMO
>> and everyone knows where to find the bugzilla anyway.
>>
>> Moving forward, I'd like all our check-ins to have a comment like
>> this unless the change is so trivial that no bugzilla was ever entered.
>>
>> What do others think about this idea?
>>
>> Regards,
>> Thomas Hallgren
>>
>> _______________________________________________
>> buckminster-dev mailing list
>> buckminster-dev@eclipse.org
>> https://dev.eclipse.org/mailman/listinfo/buckminster-dev
>
> --
> Karel
> Brezina | karel.brezina@cloudsmith.com | +420.732.781459 | skype:
> karel.brezina
> CLOUDSMITH | Czech Republic
--------------030509040305090509080306
Content-Type: text/html; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type">
</head>
<body bgcolor="#ffffff" text="#000000">
+1<br>
<br>
For EMF we always use [<bugzilla-id>] <rest of comment><br>
<br>
This lets us generate release notes for each build automatically... We
can even resolve these bugs automatically after the build picks them up.<br>
<br>
<br>
Karel Brezina wrote:
<blockquote
cite="mid:mailman.1.1249910634.137038.buckminster-dev@eclipse.org"
type="cite">
<meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type">
+1<br>
<br>
Karel<br>
<br>
<br>
Thomas Hallgren napsal(a):
<blockquote cite="mid:h5oqun$vaf$1@build.eclipse.org" type="cite">Hi,
<br>
I would like us to unify our check-in comments. I know that many
projects use comments similar to this one: <br>
<br>
Bug 283104 - Qualifier replacement disabled when keyword 'qualifier'
is prefixed <br>
<br>
i.e. the relevant bugzilla number and its heading. I've been using this
style too lately. This comment style makes it very easy to create list
of what's changed since the last release and it's also very easy to
bring up information about the actual bug, should the need arise.
Entering the full URL clobbers the real information IMO and everyone
knows where to find the bugzilla anyway. <br>
<br>
Moving forward, I'd like all our check-ins to have a comment like this
unless the change is so trivial that no bugzilla was ever entered. <br>
<br>
What do others think about this idea? <br>
<br>
Regards, <br>
Thomas Hallgren <br>
<br>
_______________________________________________ <br>
buckminster-dev mailing list <br>
<a moz-do-not-send="true" class="moz-txt-link-abbreviated"
href="mailto:buckminster-dev@eclipse.org">buckminster-dev@eclipse.org</a>
<br>
<a moz-do-not-send="true" class="moz-txt-link-freetext"
href="https://dev.eclipse.org/mailman/listinfo/buckminster-dev">https://dev.eclipse.org/mailman/listinfo/buckminster-dev</a>
<br>
</blockquote>
<br>
<div class="moz-signature">-- <br>
<style type="text/css">
..delimiter {
font-size: 11px;
font-weight: bold;
color:#007E00;
font-family: Geneva;
}
</style>
<span
style="font-family: Helvetica,Verdana,Arial; font-size: 9pt; color: rgb(103, 103, 103);">Karel
Brezina<span class="delimiter"> | </span><a moz-do-not-send="true"
class="moz-txt-link-abbreviated"
href="mailto:karel.brezina@cloudsmith.com">karel.brezina@cloudsmith.com</a><span
class="delimiter"> | </span>+420.732.781459<span class="delimiter"> | </span>skype:
karel.brezina</span><br>
<span
style="font-family: Geneva; font-size: 11pt; color: rgb(19, 149, 214); font-weight: bold;">CLOUDSMITH<span
class="delimiter"> | </span><span
style="font-size: 9pt; color: rgb(103, 103, 103); font-weight: normal; font-family: Helvetica;">Czech
Republic</span></span>
</div>
</blockquote>
</body>
</html>
--------------030509040305090509080306--
|
|
| |
| Re: [buckminster-dev] Check-in comments [message #480424 is a reply to message #479211] |
Mon, 17 August 2009 02:28 |
| Eclipse User |
|
|
|
--0015174bdf2820711d04715082d6
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
+1
Guillaume - sorry for the late answer.
On Tue, Aug 11, 2009 at 1:46 PM, Stefan Daume
<stefan.daume@cloudsmith.com>wrote:
> +1
>
> Stefan
>
>
> Thomas Hallgren wrote:
>
>> Hi,
>> I would like us to unify our check-in comments. I know that many projects
>> use comments similar to this one:
>>
>> Bug 283104 - Qualifier replacement disabled when keyword 'qualifier' is
>> prefixed
>>
>> i.e. the relevant bugzilla number and its heading. I've been using this
>> style too lately. This comment style makes it very easy to create list of
>> what's changed since the last release and it's also very easy to bring up
>> information about the actual bug, should the need arise. Entering the full
>> URL clobbers the real information IMO and everyone knows where to find the
>> bugzilla anyway.
>>
>> Moving forward, I'd like all our check-ins to have a comment like this
>> unless the change is so trivial that no bugzilla was ever entered.
>>
>> What do others think about this idea?
>>
>> Regards,
>> Thomas Hallgren
>>
>> _______________________________________________
>> buckminster-dev mailing list
>> buckminster-dev@eclipse.org
>> https://dev.eclipse.org/mailman/listinfo/buckminster-dev
>>
>>
> _______________________________________________
> buckminster-dev mailing list
> buckminster-dev@eclipse.org
> https://dev.eclipse.org/mailman/listinfo/buckminster-dev
>
--0015174bdf2820711d04715082d6
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
+1<br><br>Guillaume - sorry for the late answer.<br><br><div class=3D"gmail=
_quote">On Tue, Aug 11, 2009 at 1:46 PM, Stefan Daume <span dir=3D"ltr"><=
;<a href=3D"mailto:stefan.daume@cloudsmith.com">stefan.daume@cloudsmith.com=
</a>></span> wrote:<br>
<blockquote class=3D"gmail_quote" style=3D"border-left: 1px solid rgb(204, =
204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">+1<br><font color=
=3D"#888888">
<br>
=C2=A0 Stefan</font><div><div></div><div class=3D"h5"><br>
<br>
Thomas Hallgren wrote:<br>
<blockquote class=3D"gmail_quote" style=3D"border-left: 1px solid rgb(204, =
204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
Hi,<br>
I would like us to unify our check-in comments. I know that many projects u=
se comments similar to this one:<br>
<br>
=C2=A0Bug 283104 - Qualifier replacement disabled when keyword 'qualif=
ier' is prefixed<br>
<br>
i.e. the relevant bugzilla number and its heading. I've been using this=
style too lately. This comment style makes it very easy to create list of =
what's changed since the last release and it's also very easy to br=
ing up information about the actual bug, should the need arise. Entering th=
e full URL clobbers the real information IMO and everyone knows where to fi=
nd the bugzilla anyway.<br>
<br>
Moving forward, I'd like all our check-ins to have a comment like this =
unless the change is so trivial that no bugzilla was ever entered.<br>
<br>
What do others think about this idea?<br>
<br>
Regards,<br>
Thomas Hallgren<br>
<br>
_______________________________________________<br>
buckminster-dev mailing list<br>
<a href=3D"mailto:buckminster-dev@eclipse.org" target=3D"_blank">buckminste=
r-dev@eclipse.org</a><br>
<a href=3D"https://dev.eclipse.org/mailman/listinfo/buckminster-dev" target=
=3D"_blank">https://dev.eclipse.org/mailman/listinfo/buckminster-dev</a><br=
>
<br>
</blockquote>
<br>
_______________________________________________<br>
buckminster-dev mailing list<br>
<a href=3D"mailto:buckminster-dev@eclipse.org" target=3D"_blank">buckminste=
r-dev@eclipse.org</a><br>
<a href=3D"https://dev.eclipse.org/mailman/listinfo/buckminster-dev" target=
=3D"_blank">https://dev.eclipse.org/mailman/listinfo/buckminster-dev</a><br=
>
</div></div></blockquote></div><br>
--0015174bdf2820711d04715082d6--
|
|
|
Goto Forum:
Current Time: Sun Apr 20 10:17:51 EDT 2025
Powered by FUDForum. Page generated in 0.04962 seconds |
Home