[openstack-dev] #TODO management

Russell Bryant rbryant at redhat.com
Mon Mar 4 18:31:24 UTC 2013


On 03/04/2013 12:03 PM, Daniel P. Berrange wrote:
> 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 ?

+1

-- 
Russell Bryant



More information about the OpenStack-dev mailing list