Skip to content

πŸ› οΈ [TASK] : Implement TODO Comment Checker in CIΒ #188

@bkioshn

Description

@bkioshn

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/

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    πŸ“‹ Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions