Steeltoe icon indicating copy to clipboard operation
Steeltoe copied to clipboard

Address S1135: Track uses of "TODO" tags

Open bart-vmware opened this issue 3 years ago • 0 comments

Address existing violations of S1135: Track uses of "TODO" tags in the codebase and set severity to Info in Steeltoe.Debug.ruleset and to Warning in Steeltoe.Release.ruleset.

Note: The difference in severities between Debug/Release is to avoid distraction or hindrance while writing/debugging code.

To find existing violations, enable the rule (see above) and rebuild src/Steeltoe.All.sln to make them appear in the Output window.

To address the violations, choose from the following on a case-by-case basis:

  • If the TODO no longer applies, remove the comment from the code
  • If resolving the TODO is trivial, add the missing code (and consider adding tests for it)
  • If the TODO represents non-trivial work to be potentially addressed in the future, remove the comment and create a GitHub issue for it, labeled 'Type/enhancement'
  • ~Suppress the violation in code using #pragma warning disable/restore, preceded by a justification comment if not obvious~

bart-vmware avatar Jul 28 '22 09:07 bart-vmware