mesos-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Alexander Rojas <alexan...@mesosphere.io>
Subject Re: Add JIRA ticket# to `TODO`s in comments
Date Wed, 11 Nov 2015 09:11:42 GMT
+1

This also provides a way of removing TODO’s since they are traceable. If you look in the
code, there are TODO’s which are no relevant anymore or probably cannot be understood from
their actual context.

> On 08 Nov 2015, at 05:50, Kapil Arya <kapil@mesosphere.io> wrote:
> 
> Folks,
> 
> I wanted to bring up a style issue related to the TODO tag in comments. I
> have filed a Jira ticket (https://issues.apache.org/jira/browse/MESOS-3850)
> with the following description:
> 
> Currently, we have a TODO(<username-of-original-author>) tags to note stuff
> has "should be"/"has to be" done in future. While this provides us with
> some notion of accounting, it's not enough.
> 
> The author listed in the TODO comment should be considered the "Reporter",
> but not necessarily the "Assignee". Further, since the stuff "should
> be"/"has to be" done, why not have a Jira issue tracking it?
> 
> We can use TODO(MESOS-XXX) or TODO(<Reporter>:MESOS-XXX) or something
> similar. Finally, we might wan to consider adding this to the style guide
> to make it a soft/hard requirement.
> 
> 
> Are there any opinions/suggestions on this one?
> 
> Best,
> Kapil


Mime
View raw message