Skip to content
This repository has been archived by the owner on Oct 19, 2024. It is now read-only.

TODO linter #110

Open
lnihlen opened this issue Jun 19, 2022 · 3 comments
Open

TODO linter #110

lnihlen opened this issue Jun 19, 2022 · 3 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed infrastructure Automation and tooling supporting development

Comments

@lnihlen
Copy link
Member

lnihlen commented Jun 19, 2022

Write a program that scans all input source code (including Bison, Ragel, C++, sclang) for TODO comments, and generates an error for any TODOs that don't have an associated bug link. So

// TODO(https://github.com/hadron-sclang/hadron/issues/110): short explanation of issue

is the only acceptable format of TODO comment according to the script. We can put this in as part of the linting stage.

@lnihlen lnihlen added help wanted Extra attention is needed good first issue Good for newcomers labels Jun 19, 2022
@lnihlen
Copy link
Member Author

lnihlen commented Jun 19, 2022

For bonus points you could also check if the issue is still open/valid, and error out if its been closed..

@lnihlen
Copy link
Member Author

lnihlen commented Jun 19, 2022

Probably best to re-use something like: https://github.com/todogroup/repolinter

@lnihlen
Copy link
Member Author

lnihlen commented Jun 19, 2022

@lnihlen lnihlen added infrastructure Automation and tooling supporting development good first issue Good for newcomers and removed good first issue Good for newcomers labels Jun 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue Good for newcomers help wanted Extra attention is needed infrastructure Automation and tooling supporting development
Projects
None yet
Development

No branches or pull requests

1 participant