search

src-d / guide

Aiming to be a fully transparent company. All information about source{d} and what it's like to work here.
Creative Commons Attribution Share Alike 4.0 International
293 stars 102 forks source link

Add TODO comment convention #375

Closed dennwc closed 5 years ago

dennwc commented 5 years ago

Defines a TODO comment convention. Resolves #327.

Signed-off-by: Denys Smirnov denys@sourced.tech

ncordon commented 5 years ago

As a suggestion, especially for new people joining the company as me, I would add that the user in TODO(user) is who writs the comment, maybe someone to have as reference if some further feedback is required for the comment, but not necessarily who should address that TODO. I say this because I found it misleading at first.

dennwc commented 5 years ago

@ncordon I good idea, thanks! Added more description about the user name.

@agarciamontoro Fixed!