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

Added pre-commit config #683

Merged
merged 3 commits into from
Feb 14, 2024
Merged

Added pre-commit config #683

merged 3 commits into from
Feb 14, 2024

Conversation

pfebrer
Copy link
Contributor

@pfebrer pfebrer commented Feb 14, 2024

With pre-commit changes to versions of the checker tools (e.g. isort and black) or even addition/removal of tools will be easier to track. That is, if this config changes, pre-commit will automatically update the environment when a developer tries to add a new commit. This ensures that everyone is using exactly the same tools, and that they don't forget to run them.

If pre-commit is not set up, this file does nothing.

To set it up:

  • Install pre-commit: pip install pre-commit
  • Run install on root directory: pre-commit install

@zerothi
Copy link
Owner

zerothi commented Feb 14, 2024

Great, could you add a small comment in CONTRIBUTING.md, great!

@zerothi zerothi merged commit 8c53910 into zerothi:main Feb 14, 2024
1 check passed
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.

2 participants