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

Ensure that no unwanted TODOs or FIXMEs remain before merging #261

Open
maximedenes opened this issue Dec 6, 2022 · 3 comments
Open

Ensure that no unwanted TODOs or FIXMEs remain before merging #261

maximedenes opened this issue Dec 6, 2022 · 3 comments
Labels
enhancement New feature or request

Comments

@maximedenes
Copy link
Member

It would be a nice feature. Not sure if it should be the job of coqbot or a linter.

@ticket-tagger ticket-tagger bot added the enhancement New feature or request label Dec 6, 2022
@Alizter
Copy link
Contributor

Alizter commented Dec 6, 2022

Ideally part of the linter, but is it really what we want? Sometimes there are good reasons to leave TODOs.

@Zimmi48
Copy link
Member

Zimmi48 commented Dec 7, 2022

@jfehrle has a strategy of distinguishing todo PR (needs to be resolved before merging) and todo (for latter consideration). I've always been reluctant of adding TODOs in the code myself, but they can make sense when the point raised might be especially relevant for the next person looking at the code. It seems like lots of people have considering automatically creating issues from TODOs in code (https://www.google.com/search?client=firefox-b-d&q=todo+in+code+and+issues) and there is more generally quite some literature on TODO code comments (https://scholar.google.fr/scholar?hl=en&as_sdt=0%2C5&q=todo+code+comments&btnG=). Some reading for later (I don't have time for this right now, unfortunately 😉).

@maximedenes
Copy link
Member Author

Let's not over-engineer things. The feature request is a warning. A reviewer or the PR author can then take the right decision.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants