This repository has been archived by the owner on Jun 10, 2022. It is now read-only.
Cleanup lint warnings #572
Merged
Conversation
This file contains 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
Contributor
eanders-ms
commented
May 5, 2020
eanders-ms
commented
- Allow TODO comments for the time being.
- Fix formatting in collider.ts.
stevenvergenz
suggested changes
May 5, 2020
| @@ -59,7 +59,7 @@ module.exports = { | |||
| "no-shadow": "warn", | |||
| "no-unmodified-loop-condition": "error", | |||
| "no-void": "error", | |||
| "no-warning-comments": ["warn", {"terms": ["todo", "fixme", "tslint"]}], | |||
| "no-warning-comments": ["warn", {"terms": ["fixme", "tslint"]}], | |||
There was a problem hiding this comment.
I like the lint warning, to remind us "to do" whatever is mentioned. If there's a TODO in an infrequently reviewed code path, we might not see it or be aware of it.
There was a problem hiding this comment.
We need a clean build. Some reasons:
- As new developers start working in the codebase, if they see a bunch of warnings the first time they build it, they'll never pay attention to the build output again. They won't notice any new warnings their changes might introduce.
- Tracking todos via lint warnings doesn't scale. Actionable todos should be tracked in GitHub issues. That way they're searchable, assignable, taggable, and can be prioritized.
There was a problem hiding this comment.
I think the intention was that we shouldn't let TODOs pile up, but I see your point. Approved.
stevenvergenz
approved these changes
May 5, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.