cuttle icon indicating copy to clipboard operation
cuttle copied to clipboard

[DevEx]: Organize `// TODO` and `// FIXME` comments

Open itsalaidbacklife opened this issue 1 year ago • 1 comments

Improvement Summary

Every comment with a FIXME or TODO should be updated to have a standard format so that we can more easily find them, and so they are linked to a specific issue.

Detailed Description

We should replace every // FIXME and // TODO comment with a // TODO that includes an issue number to address it, with additional comments after the issue number, like so:

// TODO #965 - Remove this

or

// TODO #1094 - add translations

This way we can easily find any comments for future work by searching for // TODO #, and we can search for all todos for a given issue e.g. #965 by searching for // TODO #965.

We should update all the existing FIXME and TODO comments to match this format and ensure they have an issue associated with them, either removing them or writing up the issue to ensure this is done.

itsalaidbacklife avatar Dec 31 '24 16:12 itsalaidbacklife

Hey @itsalaidbacklife I am going to work on this!

jerryh-jr avatar Jan 13 '25 00:01 jerryh-jr