Ban TODO comments, require FIXME comments #2511
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This allows us to leave TODO comments for things that should be resolved before a PR is merged, and have stronger guarantees that these will actually be resolved. Previously, we've manually created GitHub PR review comments for TODO comments, which has let some TODOs through by accident, and is generally a waste of developer time. gherrit-pr-id: I4b767eb773d725fce0abefbefbe74c24a4b56d90
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2511 +/- ##
=======================================
Coverage 90.36% 90.37%
=======================================
Files 19 19
Lines 7808 7809 +1
=======================================
+ Hits 7056 7057 +1
Misses 752 752 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
jswrenn
suggested changes
Apr 25, 2025
Comment on lines
+25
to
+28
| echo "Found $KEYWORD markers in the codebase." >&2 | ||
| echo "$KEYWORD is used for tasks that should be done before merging a PR; if you want to leave a message in the codebase, use FIXME." >&2 | ||
| echo "" >&2 | ||
| echo "$output" >&2 |
There was a problem hiding this comment.
There was a problem hiding this comment.
Though perhaps use ::notice, to be a bit less visually disruptive.
There was a problem hiding this comment.
Maybe let's follow up in a separate PR so we can do that to all of our CI scripts at once? We'll also need to figure out how to make the output nice when run from a git pre-push hook.
jswrenn
approved these changes
Apr 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This allows us to leave TODO comments for things that should be resolved
before a PR is merged, and have stronger guarantees that these will
actually be resolved. Previously, we've manually created GitHub PR
review comments for TODO comments, which has let some TODOs through by
accident, and is generally a waste of developer time.
This PR is on branch ban-todo.