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

New Bot: TODO bot #1301

Open
chingor13 opened this issue Jan 21, 2021 · 6 comments · May be fixed by #4443
Open

New Bot: TODO bot #1301

chingor13 opened this issue Jan 21, 2021 · 6 comments · May be fixed by #4443
Labels
type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@chingor13
Copy link
Contributor

chingor13 commented Jan 21, 2021

Scan for instances of TODOs/FIXMEs in code and maintain issues on the repository.

Potentially assign to a person if tagged. Example: TODO(chingor13): do something

@chingor13 chingor13 added the type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. label Jan 21, 2021
@tmatsuo
Copy link
Contributor

tmatsuo commented Feb 26, 2021

If the TODO has a bug number, like TODO(#1301): add TODO bot, I think it makes sense to block a closing PR when the TODO is still there?

@bcoe
Copy link
Contributor

bcoe commented Apr 9, 2021

@tmatsuo perhaps we could add a convention like TODO(tmatsuo): add todo bot Refs: #939?

That way we still get user assignment.

@tmatsuo
Copy link
Contributor

tmatsuo commented Apr 9, 2021

@bcoe That works for me. @coryan WDYT?

@coryan
Copy link
Member

coryan commented Apr 9, 2021

I do not think developer names attached to TODOs make sense. What happens when they leave? What happens if somebody else wants to work on it?

In C++ the Google style guide requires 80 columns. Horizontal space is at a premium, // TODO(person): ... refs: #.... steals too much of it.

My $0.02: it should always be // TODO(#number) - action to take here

@tmatsuo
Copy link
Contributor

tmatsuo commented Apr 9, 2021

That's a good point. Referring to a github issue is more robust than assigning a member. We can assign members to that issue.

@chingor13
Copy link
Contributor Author

Previously, this was infeasible if we rely on the GitHub code search API (rate limits). Now, with Cloud Run, we can shallow clone the code and use grep to search for TODO entries.

Additionally, the bot could lint TODO comments

@chingor13 chingor13 linked a pull request Sep 21, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants