Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Buckminster dev » Check-in comments
Check-in comments [message #479211] Mon, 10 August 2009 09:57 Go to next message
Thomas Hallgren is currently offline Thomas Hallgren
Messages: 3229
Registered: July 2009
Senior Member
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 #479213 is a reply to message #479211] Mon, 10 August 2009 10:03 Go to previous messageGo to next message
Michal Ruzicka is currently offline Michal Ruzicka
Messages: 23
Registered: July 2009
Junior Member
+1
Michal Ruzicka

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
Re: [buckminster-dev] Check-in comments [message #479214 is a reply to message #479211] Mon, 10 August 2009 10:03 Go to previous messageGo to next message
Michal Ruzicka is currently offline Michal Ruzicka
Messages: 23
Registered: July 2009
Junior Member
+1
Michal Ruzicka

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
Re: Check-in comments [message #479243 is a reply to message #479211] Mon, 10 August 2009 12:47 Go to previous messageGo to next message
Achim Demelt is currently offline Achim Demelt
Messages: 160
Registered: July 2009
Senior Member
+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: Check-in comments [message #479256 is a reply to message #479211] Mon, 10 August 2009 13:21 Go to previous messageGo to next message
Henrik Lindberg is currently offline Henrik Lindberg
Messages: 2500
Registered: July 2009
Senior Member
+1
- henrik

Thomas Hallgren wrote:

> 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 #479259 is a reply to message #479211] Mon, 10 August 2009 13:23 Go to previous messageGo to next message
Filip Hrbek is currently offline Filip Hrbek
Messages: 233
Registered: July 2009
Senior Member
+1

Filip

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
>
Re: [buckminster-dev] Check-in comments [message #479261 is a reply to message #479211] Mon, 10 August 2009 13:23 Go to previous messageGo to next message
Karel Brezina is currently offline Karel Brezina
Messages: 68
Registered: July 2009
Member
<!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>
&nbsp; 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">&nbsp;&nbsp;|&nbsp;&nbsp; </span><a class="moz-txt-link-abbreviated" href="mailto:karel.brezina@cloudsmith.com">karel.brezina@cloudsmith.com</a><span
class="delimiter">&nbsp;&nbsp;|&nbsp;&nbsp; </span>+420.732.781459<span class="delimiter">&nbsp;&nbsp;|&nbsp;&nbsp; </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">&nbsp;&nbsp;|&nbsp;&nbsp; </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: Check-in comments [message #479262 is a reply to message #479243] Mon, 10 August 2009 13:29 Go to previous messageGo to next message
Henrik Lindberg is currently offline Henrik Lindberg
Messages: 2500
Registered: July 2009
Senior Member
Achim Demelt wrote:

> 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.
>
+1 - for the cases where the new code does something that looks odd or
where you think someone is tempted to make subsequent changes and they
should be aware of all the consequences. (Reference to fixed issues in
ECF helped me understand why certain things worked the way they did, and
prevented me from making some tempting changes to timeout values).

- henrik
Re: [buckminster-dev] Check-in comments [message #479276 is a reply to message #479261] Mon, 10 August 2009 14:10 Go to previous messageGo to next message
Ed Merks is currently offline Ed Merks
Messages: 26126
Registered: July 2009
Senior Member
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 [&lt;bugzilla-id&gt;] &lt;rest of comment&gt;<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>
&nbsp; 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">&nbsp;&nbsp;|&nbsp;&nbsp; </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">&nbsp;&nbsp;|&nbsp;&nbsp; </span>+420.732.781459<span class="delimiter">&nbsp;&nbsp;|&nbsp;&nbsp; </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">&nbsp;&nbsp;|&nbsp;&nbsp; </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 #479518 is a reply to message #479211] Tue, 11 August 2009 11:46 Go to previous messageGo to next message
Stefan Daume is currently offline Stefan Daume
Messages: 22
Registered: July 2009
Junior Member
+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
>
Re: [buckminster-dev] Check-in comments [message #480424 is a reply to message #479211] Mon, 17 August 2009 06:28 Go to previous message
Guillaume Chatelet is currently offline Guillaume Chatelet
Messages: 146
Registered: July 2009
Senior Member
--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">&lt=
;<a href=3D"mailto:stefan.daume@cloudsmith.com">stefan.daume@cloudsmith.com=
</a>&gt;</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 &#39;qualif=
ier&#39; is prefixed<br>
<br>
i.e. the relevant bugzilla number and its heading. I&#39;ve been using this=
style too lately. This comment style makes it very easy to create list of =
what&#39;s changed since the last release and it&#39;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&#39;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--
Previous Topic:[buckminster-dev] question about rmap and mutable and anon
Next Topic:[buckminster-dev] having new trouble running hello world xml example.
Goto Forum:
  


Current Time: Mon Oct 20 18:02:55 GMT 2014

Powered by FUDForum. Page generated in 0.11619 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software