[DevEx]: Organize // TODO
and // FIXME
comments
#1141
Labels
dev experience
Improvements to the code base that make it easier/better/more enjoyable to contribute to Cuttle
version-patch
An update that warrants a bumping the project's patch version (e.g. 4.0.0 => 4.0.1)
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:or
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.
The text was updated successfully, but these errors were encountered: