Use Reviewdog to Annotate PRs with Pylint and Spellcheck #2666
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
Signed-off-by: Isaac Milarsky <[email protected]>
Signed-off-by: Isaac Milarsky <[email protected]>
|
Example of Pylint check in use on this PR: DSACMS/metrics#74 |
|
I am currently fixing the docs build error that exists across the board following readthedocs.io changes last week. |
sgoggins
approved these changes
Jan 18, 2024
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.
Description
Notes for Reviewers
I decided on Pylint because it's not that strict of a linter. We should consider how strict we are willing to be on linting and checking in general in the future as reviewdog supports many tools. Some good linting alternatives are listed in the readme for the reviewdog repo
We can also automatically force new PRs to follow PEP8 but that might be overkill.
Signed commits