Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DevEx]: Organize // TODO and // FIXME comments #1141

Open
itsalaidbacklife opened this issue Dec 31, 2024 · 1 comment
Open

[DevEx]: Organize // TODO and // FIXME comments #1141

itsalaidbacklife opened this issue Dec 31, 2024 · 1 comment
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)

Comments

@itsalaidbacklife
Copy link
Contributor

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 itsalaidbacklife added 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) labels Dec 31, 2024
@jerryh-jr
Copy link
Contributor

Hey @itsalaidbacklife I am going to work on this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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)
Projects
None yet
Development

No branches or pull requests

2 participants