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

🛠️ [TASK] : Implement TODO Comment Checker in CI #188

Open
Tracked by #156 ...
bkioshn opened this issue Feb 6, 2024 · 0 comments
Open
Tracked by #156 ...

🛠️ [TASK] : Implement TODO Comment Checker in CI #188

bkioshn opened this issue Feb 6, 2024 · 0 comments

Comments

@bkioshn
Copy link
Contributor

bkioshn commented Feb 6, 2024

Summary

Implement TODO Comment Checker in CI

Description

Description:

As our codebase grows, it's essential to maintain consistency and ensure that all TODO comments follow a specific format and have valid associated links.

Features:

  1. Ensure that TODO follows the following format.
TODO (github_name) : <link>

where

  • github_name is the github name of the person who creates this TODO
  • link a link to a valid issue
  1. Link Validation: The associated link provided in the TODO comment should be validated for its correctness and accessibility. Invalid links should trigger an error.

The checker should be implemented using python where this library can be used if possible
https://pypi.org/project/comment-parser/

@bkioshn bkioshn moved this to 📋 Backlog in Catalyst Feb 6, 2024
@bkioshn bkioshn changed the title Implement TODO Comment Checker in CI 🛠️ [TASK] : Implement TODO Comment Checker in CI Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant