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

[Documentation]: Suggestion - enable https://pre-commit.ci/ #106

Open
rkm opened this issue Sep 20, 2023 · 0 comments
Open

[Documentation]: Suggestion - enable https://pre-commit.ci/ #106

rkm opened this issue Sep 20, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@rkm
Copy link
Member

rkm commented Sep 20, 2023

What documentation issue are you reporting

Formatting

Issue

We already have a .pre-commit-config.yaml in the repo, but this is not run if contributors don't have pre-commit installed locally or if they submit a PR directly in GitHub.

We could add https://pre-commit.ci to the repo, which will ensure the checks are run on every PR. Any formatting changes will also be automatically committed back to the branch by the tool, which is handy.

@rkm rkm added the documentation Improvements or additions to documentation label Sep 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant