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

Reply via email to