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

Use Reviewdog to Annotate PRs with Pylint and Spellcheck #11

Merged
merged 2 commits into from
Jan 19, 2024

Conversation

IsaacMilarky
Copy link
Collaborator

Use Reviewdog to Annotate PRs with Pylint and Spellcheck

Problem

No linting or spellcheck exists on PRs into this repo.

Solution

  • Add GitHub workflow to run reviewdog and annotate with relevant linters and checkers
  • When a PR is created into either dev or main, pylint checks are ran and annotated on that PR for review
  • The only files considered are the ones that contain changes to not be overwhelming

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

Signed-off-by: Isaac Milarsky <isaac.milarsky@hhs.cms.gov>
Signed-off-by: Isaac Milarsky <isaac.milarsky@hhs.cms.gov>
@IsaacMilarky
Copy link
Collaborator Author

Also tagging @natalialuzuriaga

@natalialuzuriaga
Copy link
Collaborator

LGTM 👍

Copy link
Contributor

@patsier-cms patsier-cms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! I'm a big fan of black because of how strict it is, but up to you all as long as some conventions are enforced

@IsaacMilarky IsaacMilarky merged commit 5c6948a into dev Jan 19, 2024
2 checks passed
@IsaacMilarky IsaacMilarky deleted the add-gh-checks branch January 19, 2024 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants