Kapil Arya created MESOS-3850:
---------------------------------
Summary: Add JIRA issue# to `TODO`s in comments
Key: MESOS-3850
URL: https://issues.apache.org/jira/browse/MESOS-3850
Project: Mesos
Issue Type: Improvement
Components: documentation
Reporter: Kapil Arya
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.
2.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
