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

running pre-commit locally #296

Merged
merged 3 commits into from
Jun 14, 2022

Conversation

soumilbaldota
Copy link
Contributor

@soumilbaldota soumilbaldota commented Jun 3, 2022

BEGINRELEASENOTES

  • Add instructions on how to run pre-commit locally to the documentation

ENDRELEASENOTES

@tmadlener
Copy link
Collaborator

Thanks for adding this. I have a few minor comments:

  • I think the installation via pip is probably more widespread, as it is probably more widespread than pip (especially if you already have a python installation)
  • Instead of pointing to the brew homepage, could you instead point to the pre-commit homepage (https://pre-commit.com/)? That effectively has all the installation and usage instructions on their landing page.
  • There seem to be some whitespace issues that fail the pre-commit workflow. If you run that locally, I think it automatically fixes these (we have not enabled this in CI though).

@tmadlener tmadlener merged commit 7f083af into AIDASoft:master Jun 14, 2022
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.

None yet

2 participants