Avoid TODO comments in source code

[cbartz]

While reviewing PRs, I tend to comment on TODO comments.

I created this PR to see if we can reach an agreement or start a discussion about the topic.

[nrobinaubertin]

In general I would agree but TODOs in code exist because they are frictionless. I fear that enforcing that would just mean that TODOs wouldn't be written anymore (without any jira ticket).

[varshigupta12]

In general TODOs should be resolved before merging the code and if there are any long standing pending items, JIRA tickets should be created instead.

[cbartz]

In general I would agree but TODOs in code exist because they are frictionless. I fear that enforcing that would just mean that TODOs wouldn't be written anymore (without any jira ticket).

I think exceptions to the contribution guidelines can always be made for certain cases if they are well explained, but the goal should be to avoid merging code with TODO comments to the default branch. Although TODO comments are frictionless, they reduce readability later on. It's still fine to have TODO comments on a feature PR before merging.