You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@flex.apache.org by Justin Mclean <ju...@classsoftware.com> on 2012/02/26 23:32:26 UTC
referencing JIRA issues in code
Hi,
Just wondering what the policy should be on referencing JIRA issues in code comments
Do we:
1. Don't need to do it as it's contained in the SVN history
2. Mention issue by name
// some random fix (FLEX-123)
3. Have a URL to the issue
// some random fix (https://issues.apache.org/jira/browse/FLEX-123)
4. Something else?
Thanks,
Justin
RE: referencing JIRA issues in code
Posted by David Arno <da...@davidarno.org>.
> From: Yennick Trevels [mailto:yennick.trevels@gmail.com]
>Sent: 27 February 2012 07:24
> Imo we shouldn't include those comments in the code, it's already in the
> SVN history and if we write a unit test when we fix something then it's
covered
> there also which should avoid regression bugs. It would just clutter the
code.
Wise words Yennick. 100% agree with you.
Re: referencing JIRA issues in code
Posted by Yennick Trevels <ye...@gmail.com>.
Imo we shouldn't include those comments in the code, it's already in the
SVN history and if we write a unit test when we fix something then it's
covered there also which should avoid regression bugs. It would just
clutter the code.
Re: referencing JIRA issues in code
Posted by Pierangelo Mancusi <pi...@gmail.com>.
5. //issue: FLEX-123
//some fix
code....
Il giorno 26 febbraio 2012 23:41, Jun Heider <ju...@realeyes.com> ha scritto:
>
> On Feb 26, 2012, at 3:32 PM, Justin Mclean wrote:
> >
> > 2. Mention issue by name
> > // some random fix (FLEX-123)
>
> Based on previous discussion and also personal pref, I think the above
> should be the way to go.
>
>
Re: referencing JIRA issues in code
Posted by Jun Heider <ju...@realeyes.com>.
On Feb 26, 2012, at 3:32 PM, Justin Mclean wrote:
>
> 2. Mention issue by name
> // some random fix (FLEX-123)
Based on previous discussion and also personal pref, I think the above should be the way to go.
Re: referencing JIRA issues in code
Posted by Haykel BEN JEMIA <ha...@gmail.com>.
I would not clutter the code with this information. It should be enough to
have it in SVN and Jira.
Haykel
Re: referencing JIRA issues in code
Posted by John Fletcher <fl...@gmail.com>.
I agree on no bug numbers. Except I think it's valid in a temporary comment
where you have a hack because you are awaiting a fix in another issue. Like
"We have to check for null here due to a bug in Label - see FLEX-99"
John
Re: referencing JIRA issues in code
Posted by Carol Frampton <cf...@adobe.com>.
I really dislike bug numbers in the code. As other said the svn history
is there. The only time where it might be ok is if it is a very complex
issue which needs lots and lots of explanation and you don't want to
clutter the code with a comment with that much detail. You should still
put in a summary comment with the bug number, in this format: [FLEX-99].
Carol
On 2/27/12 3 :03AM, "Alex Harui" <ah...@adobe.com> wrote:
>
>
>
>On 2/26/12 2:32 PM, "Justin Mclean" <ju...@classsoftware.com> wrote:
>
>> Hi,
>>
>> Just wondering what the policy should be on referencing JIRA issues in
>>code
>> comments
>>
>> Do we:
>> 1. Don't need to do it as it's contained in the SVN history
>>
>Adobe policy was not to put bug numbers in the code. I believe there are
>some exceptions though.
>
>--
>Alex Harui
>Flex SDK Team
>Adobe Systems, Inc.
>http://blogs.adobe.com/aharui
>
Re: referencing JIRA issues in code
Posted by Alex Harui <ah...@adobe.com>.
On 2/26/12 2:32 PM, "Justin Mclean" <ju...@classsoftware.com> wrote:
> Hi,
>
> Just wondering what the policy should be on referencing JIRA issues in code
> comments
>
> Do we:
> 1. Don't need to do it as it's contained in the SVN history
>
Adobe policy was not to put bug numbers in the code. I believe there are
some exceptions though.
--
Alex Harui
Flex SDK Team
Adobe Systems, Inc.
http://blogs.adobe.com/aharui