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

Encourage devs to avoid TODO comments #1681

Open
samayer12 opened this issue Jan 16, 2025 · 0 comments
Open

Encourage devs to avoid TODO comments #1681

samayer12 opened this issue Jan 16, 2025 · 0 comments

Comments

@samayer12
Copy link
Contributor

Describe what should be investigated or refactored

We could apply the eslint rule no-warning-comments to the project.

Developers often add comments to code which is not complete or needs review. Most likely you want to fix or review the code, and then remove the comment, before you consider the code to be production ready.

The Pepr team already shares this value and avoids the use of TODO statements. This setting would act as a backstop for code reviewers during PR reviews.

Additional context

As of 8c466da, there are only 3 TODO statements in the code:

src/cli/init/index.ts
  39:7   warning  Unexpected 'todo' comment: 'TODO: Overrides for testing. Don't be so...'  no-warning-comments
  40:7   warning  Unexpected 'todo' comment: 'TODO: See pepr/#1140'                         no-warning-comments
src/sdk/cosign.ts
  180:1  warning  Unexpected 'todo' comment: 'TODO: should support using certs too'                 no-warning-comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🆕 New
Development

No branches or pull requests

1 participant