You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@qpid.apache.org by Marnie McCormack <ma...@googlemail.com> on 2006/11/21 10:59:50 UTC
JIRAs from TODOs
All,
I'm planning to create JIRAs for each TODO in the java codebase and then
remove them from the code, in order to make tasks trackable/visible.
Any objections ?
Marnie
Re: JIRAs from TODOs
Posted by Marnie McCormack <ma...@googlemail.com>.
Hi All,
Thanks for all the input - will leave TODOs in, add short JIRA ref to the
comment which should be removed on completion.
Regards,
Marnie
On 11/22/06, Alan Conway <ac...@redhat.com> wrote:
>
> I'd suggest just leaving the existing TODO comment in place, but insert
> the JIRA ID.
>
> On Wed, 2006-11-22 at 12:58 +0000, Andrew Stitcher wrote:
> > I think that there should be a short description of the TODO as well as
> > the Jira id. Otherwise you end up having to have a browser open whilst
> > looking at the code. At least with a short description (which maybe
> > should be the title of the Jira), you can get an idea of what needs to
> > be done and refer to Jira for more details.
> >
> > It should also go without saying that the jira references get removed
> > when the work is done, otherwise they really would litter the code.
> >
> > Andrew
> >
> > John O'Hara wrote:
> > > +1
> > >
> > > I like the idea of using JIRA's to note places where future work has
> to
> > > happen.... good traceability.
> > > This is obviously different from plonking a change history at the top
> > > of a
> > > file; which I don't think anyone is advising (that's what SVN is for).
> > >
> > > John
> > >
> > > On 21/11/06, Martin Ritchie <ri...@apache.org> wrote:
> > >>
> > >> That is what I was meaning... a simple //todo QPID-XX.
> > >>
> > >> Just thought it might make the location easier to track from the
> JIRA.
> > >> Although I'm sure a reference to the code by method name from the
> JIRA
> > >> would be enough.
> > >>
> > >> On 21/11/06, Marnie McCormack <ma...@googlemail.com>
> wrote:
> > >> > I'm not sure about littering JIRA refs in the codebase - is that
> what
> > >> you
> > >> > mean ?
> > >> >
> > >> > Apologies if I've misunderstood :-)
> > >> >
> > >> > Marnie
> > >> >
> > >> >
> > >> > On 11/21/06, Martin Ritchie <ri...@apache.org> wrote:
> > >> > >
> > >> > > Might be good to simply update the /todo in the code base so we
> can
> > >> > > have a reference in the code as a starting point.
> > >> > >
> > >> > > On 21/11/06, Marnie McCormack <ma...@googlemail.com>
> > >> wrote:
> > >> > > > All,
> > >> > > >
> > >> > > > I'm planning to create JIRAs for each TODO in the java codebase
> > >> and
> > >> then
> > >> > > > remove them from the code, in order to make tasks
> > >> trackable/visible.
> > >> > > >
> > >> > > > Any objections ?
> > >> > > >
> > >> > > > Marnie
> > >> > > >
> > >> > > >
> > >> > >
> > >> > >
> > >> > > --
> > >> > > Martin Ritchie
> > >> > >
> > >> >
> > >> >
> > >>
> > >>
> > >> --
> > >> Martin Ritchie
> > >>
> > >
> >
>
>
Re: JIRAs from TODOs
Posted by Alan Conway <ac...@redhat.com>.
I'd suggest just leaving the existing TODO comment in place, but insert
the JIRA ID.
On Wed, 2006-11-22 at 12:58 +0000, Andrew Stitcher wrote:
> I think that there should be a short description of the TODO as well as
> the Jira id. Otherwise you end up having to have a browser open whilst
> looking at the code. At least with a short description (which maybe
> should be the title of the Jira), you can get an idea of what needs to
> be done and refer to Jira for more details.
>
> It should also go without saying that the jira references get removed
> when the work is done, otherwise they really would litter the code.
>
> Andrew
>
> John O'Hara wrote:
> > +1
> >
> > I like the idea of using JIRA's to note places where future work has to
> > happen.... good traceability.
> > This is obviously different from plonking a change history at the top
> > of a
> > file; which I don't think anyone is advising (that's what SVN is for).
> >
> > John
> >
> > On 21/11/06, Martin Ritchie <ri...@apache.org> wrote:
> >>
> >> That is what I was meaning... a simple //todo QPID-XX.
> >>
> >> Just thought it might make the location easier to track from the JIRA.
> >> Although I'm sure a reference to the code by method name from the JIRA
> >> would be enough.
> >>
> >> On 21/11/06, Marnie McCormack <ma...@googlemail.com> wrote:
> >> > I'm not sure about littering JIRA refs in the codebase - is that what
> >> you
> >> > mean ?
> >> >
> >> > Apologies if I've misunderstood :-)
> >> >
> >> > Marnie
> >> >
> >> >
> >> > On 11/21/06, Martin Ritchie <ri...@apache.org> wrote:
> >> > >
> >> > > Might be good to simply update the /todo in the code base so we can
> >> > > have a reference in the code as a starting point.
> >> > >
> >> > > On 21/11/06, Marnie McCormack <ma...@googlemail.com>
> >> wrote:
> >> > > > All,
> >> > > >
> >> > > > I'm planning to create JIRAs for each TODO in the java codebase
> >> and
> >> then
> >> > > > remove them from the code, in order to make tasks
> >> trackable/visible.
> >> > > >
> >> > > > Any objections ?
> >> > > >
> >> > > > Marnie
> >> > > >
> >> > > >
> >> > >
> >> > >
> >> > > --
> >> > > Martin Ritchie
> >> > >
> >> >
> >> >
> >>
> >>
> >> --
> >> Martin Ritchie
> >>
> >
>
Re: JIRAs from TODOs
Posted by John O'Hara <jo...@gmail.com>.
And for convention "TODO" should be in there as well.
On 22/11/06, Andrew Stitcher <as...@redhat.com> wrote:
>
> I think that there should be a short description of the TODO as well as
> the Jira id. Otherwise you end up having to have a browser open whilst
> looking at the code. At least with a short description (which maybe
> should be the title of the Jira), you can get an idea of what needs to
> be done and refer to Jira for more details.
>
> It should also go without saying that the jira references get removed
> when the work is done, otherwise they really would litter the code.
>
> Andrew
>
> John O'Hara wrote:
> > +1
> >
> > I like the idea of using JIRA's to note places where future work has to
> > happen.... good traceability.
> > This is obviously different from plonking a change history at the top
> > of a
> > file; which I don't think anyone is advising (that's what SVN is for).
> >
> > John
> >
> > On 21/11/06, Martin Ritchie <ri...@apache.org> wrote:
> >>
> >> That is what I was meaning... a simple //todo QPID-XX.
> >>
> >> Just thought it might make the location easier to track from the JIRA.
> >> Although I'm sure a reference to the code by method name from the JIRA
> >> would be enough.
> >>
> >> On 21/11/06, Marnie McCormack <ma...@googlemail.com> wrote:
> >> > I'm not sure about littering JIRA refs in the codebase - is that what
> >> you
> >> > mean ?
> >> >
> >> > Apologies if I've misunderstood :-)
> >> >
> >> > Marnie
> >> >
> >> >
> >> > On 11/21/06, Martin Ritchie <ri...@apache.org> wrote:
> >> > >
> >> > > Might be good to simply update the /todo in the code base so we can
> >> > > have a reference in the code as a starting point.
> >> > >
> >> > > On 21/11/06, Marnie McCormack <ma...@googlemail.com>
> >> wrote:
> >> > > > All,
> >> > > >
> >> > > > I'm planning to create JIRAs for each TODO in the java codebase
> >> and
> >> then
> >> > > > remove them from the code, in order to make tasks
> >> trackable/visible.
> >> > > >
> >> > > > Any objections ?
> >> > > >
> >> > > > Marnie
> >> > > >
> >> > > >
> >> > >
> >> > >
> >> > > --
> >> > > Martin Ritchie
> >> > >
> >> >
> >> >
> >>
> >>
> >> --
> >> Martin Ritchie
> >>
> >
>
>
Re: JIRAs from TODOs
Posted by Andrew Stitcher <as...@redhat.com>.
I think that there should be a short description of the TODO as well as
the Jira id. Otherwise you end up having to have a browser open whilst
looking at the code. At least with a short description (which maybe
should be the title of the Jira), you can get an idea of what needs to
be done and refer to Jira for more details.
It should also go without saying that the jira references get removed
when the work is done, otherwise they really would litter the code.
Andrew
John O'Hara wrote:
> +1
>
> I like the idea of using JIRA's to note places where future work has to
> happen.... good traceability.
> This is obviously different from plonking a change history at the top
> of a
> file; which I don't think anyone is advising (that's what SVN is for).
>
> John
>
> On 21/11/06, Martin Ritchie <ri...@apache.org> wrote:
>>
>> That is what I was meaning... a simple //todo QPID-XX.
>>
>> Just thought it might make the location easier to track from the JIRA.
>> Although I'm sure a reference to the code by method name from the JIRA
>> would be enough.
>>
>> On 21/11/06, Marnie McCormack <ma...@googlemail.com> wrote:
>> > I'm not sure about littering JIRA refs in the codebase - is that what
>> you
>> > mean ?
>> >
>> > Apologies if I've misunderstood :-)
>> >
>> > Marnie
>> >
>> >
>> > On 11/21/06, Martin Ritchie <ri...@apache.org> wrote:
>> > >
>> > > Might be good to simply update the /todo in the code base so we can
>> > > have a reference in the code as a starting point.
>> > >
>> > > On 21/11/06, Marnie McCormack <ma...@googlemail.com>
>> wrote:
>> > > > All,
>> > > >
>> > > > I'm planning to create JIRAs for each TODO in the java codebase
>> and
>> then
>> > > > remove them from the code, in order to make tasks
>> trackable/visible.
>> > > >
>> > > > Any objections ?
>> > > >
>> > > > Marnie
>> > > >
>> > > >
>> > >
>> > >
>> > > --
>> > > Martin Ritchie
>> > >
>> >
>> >
>>
>>
>> --
>> Martin Ritchie
>>
>
Re: JIRAs from TODOs
Posted by John O'Hara <jo...@gmail.com>.
+1
I like the idea of using JIRA's to note places where future work has to
happen.... good traceability.
This is obviously different from plonking a change history at the top of a
file; which I don't think anyone is advising (that's what SVN is for).
John
On 21/11/06, Martin Ritchie <ri...@apache.org> wrote:
>
> That is what I was meaning... a simple //todo QPID-XX.
>
> Just thought it might make the location easier to track from the JIRA.
> Although I'm sure a reference to the code by method name from the JIRA
> would be enough.
>
> On 21/11/06, Marnie McCormack <ma...@googlemail.com> wrote:
> > I'm not sure about littering JIRA refs in the codebase - is that what
> you
> > mean ?
> >
> > Apologies if I've misunderstood :-)
> >
> > Marnie
> >
> >
> > On 11/21/06, Martin Ritchie <ri...@apache.org> wrote:
> > >
> > > Might be good to simply update the /todo in the code base so we can
> > > have a reference in the code as a starting point.
> > >
> > > On 21/11/06, Marnie McCormack <ma...@googlemail.com> wrote:
> > > > All,
> > > >
> > > > I'm planning to create JIRAs for each TODO in the java codebase and
> then
> > > > remove them from the code, in order to make tasks trackable/visible.
> > > >
> > > > Any objections ?
> > > >
> > > > Marnie
> > > >
> > > >
> > >
> > >
> > > --
> > > Martin Ritchie
> > >
> >
> >
>
>
> --
> Martin Ritchie
>
Re: JIRAs from TODOs
Posted by Martin Ritchie <ri...@apache.org>.
That is what I was meaning... a simple //todo QPID-XX.
Just thought it might make the location easier to track from the JIRA.
Although I'm sure a reference to the code by method name from the JIRA
would be enough.
On 21/11/06, Marnie McCormack <ma...@googlemail.com> wrote:
> I'm not sure about littering JIRA refs in the codebase - is that what you
> mean ?
>
> Apologies if I've misunderstood :-)
>
> Marnie
>
>
> On 11/21/06, Martin Ritchie <ri...@apache.org> wrote:
> >
> > Might be good to simply update the /todo in the code base so we can
> > have a reference in the code as a starting point.
> >
> > On 21/11/06, Marnie McCormack <ma...@googlemail.com> wrote:
> > > All,
> > >
> > > I'm planning to create JIRAs for each TODO in the java codebase and then
> > > remove them from the code, in order to make tasks trackable/visible.
> > >
> > > Any objections ?
> > >
> > > Marnie
> > >
> > >
> >
> >
> > --
> > Martin Ritchie
> >
>
>
--
Martin Ritchie
Re: JIRAs from TODOs
Posted by Marnie McCormack <ma...@googlemail.com>.
I'm not sure about littering JIRA refs in the codebase - is that what you
mean ?
Apologies if I've misunderstood :-)
Marnie
On 11/21/06, Martin Ritchie <ri...@apache.org> wrote:
>
> Might be good to simply update the /todo in the code base so we can
> have a reference in the code as a starting point.
>
> On 21/11/06, Marnie McCormack <ma...@googlemail.com> wrote:
> > All,
> >
> > I'm planning to create JIRAs for each TODO in the java codebase and then
> > remove them from the code, in order to make tasks trackable/visible.
> >
> > Any objections ?
> >
> > Marnie
> >
> >
>
>
> --
> Martin Ritchie
>
Re: JIRAs from TODOs
Posted by Martin Ritchie <ri...@apache.org>.
Might be good to simply update the /todo in the code base so we can
have a reference in the code as a starting point.
On 21/11/06, Marnie McCormack <ma...@googlemail.com> wrote:
> All,
>
> I'm planning to create JIRAs for each TODO in the java codebase and then
> remove them from the code, in order to make tasks trackable/visible.
>
> Any objections ?
>
> Marnie
>
>
--
Martin Ritchie