[openstack-dev] #TODO management

Daniel P. Berrange berrange at redhat.com
Mon Mar 4 17:03:15 UTC 2013


On Mon, Mar 04, 2013 at 08:55:25AM -0800, Dan Wendlandt wrote:
> Yeah, I agree.  Too often TODOs are put there just to tell reviewers that
> you are doing something short-sighted, but that you recognize it.  Really
> reviewers should be enforcing that there is a bug to track that item, or
> requiring it to just be done in the initial version.  There is also a use
> of a TODO which I would probably refer to as a "FUTURE" tag, which is to
> say: someday, we may plan on implementing X, and if we do that, the change
> would go here.  One could argue that those are useful comments to have in
> the code, but do not require bugs, as they do not actually represent
> deficiencies that could currently be fixed.  Perhaps we should use
> something other than TODO in that scenario.

Personally I've always used  "XXXX" or "FIXME" to indicate gross hacks that
should be fixed asap, and "TODO" for the random ideas that might be interesting
to explore in the future. So if we want to track bugs, then perhaps we could
use "FIXME bug 34242" for that purpose, and leave "TODO" for ad-hoc thoughts ?

> On Mon, Mar 4, 2013 at 3:26 AM, Thierry Carrez <thierry at openstack.org>wrote:
> 
> > Nachi Ueno wrote:
> > > Hi quantum folks
> > >
> > > I would like to propose new #TODO format.
> > >
> > > #TODO(name) bug or lb [launchpad bug id] comment
> > >
> > > example: #TODO(nati) bug100000  fix me !!
> > >
> > > There are 114 todos in code. I'm not sure they have bug report
> > >  but it's worth tracking it.
> > > http://paste.openstack.org/show/32495/
> > >
> > > I'm not suggesting fix all existing #TODOs ,but how about
> > > to this format for new #TODOs?
> >
> > Ensuring we have properly-prioritized bugs for #TODOs sounds like a
> > great idea. Not sure that's just a quantulm thing though. I'd love to
> > see the new format adopted elsewhere.

Daniel
-- 
|: http://berrange.com      -o-    http://www.flickr.com/photos/dberrange/ :|
|: http://libvirt.org              -o-             http://virt-manager.org :|
|: http://autobuild.org       -o-         http://search.cpan.org/~danberr/ :|
|: http://entangle-photo.org       -o-       http://live.gnome.org/gtk-vnc :|



More information about the OpenStack-dev mailing list