chore: Add pre-commit config file #2763
Merged
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
[pre-commit](https://pre-commit.com/) is a framework for managing git-supported pre-commit hooks. It uses a plugin system and auto-installs plugins when run. By default, this does nothing for developers, but if you install pre-commit and run ```console $ pre-commit install ``` it will register itself as a pre-commit hook with git. It will then yell at you before committing if files are not formatted correctly (I'm also adding a few other things like and end-of-file checker). It only runs on files that are staged, so it should be fast. One neat thing is that it can run clang-format, and that it installs the correct version of clang-tidy from PIP! So theoretically, with this, you should get portable automatically correctly formatted commits.
|
Looks interesting. So this basically can run the simple git-checks locally? For some things like the EOF we use for the online workflow our own version. Do we need to unify them to avoid annoying discrepancies? |
|
@AJPfleger I think they're already aligned. You're not forced to use this, and in my testing they don't conflict. We can adjust if that becomes a problem. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2763 +/- ##
==========================================
+ Coverage 49.48% 49.51% +0.02%
==========================================
Files 474 474
Lines 27075 27064 -11
Branches 12516 12507 -9
==========================================
+ Hits 13399 13401 +2
+ Misses 4762 4761 -1
+ Partials 8914 8902 -12 ☔ View full report in Codecov by Sentry. |
📊: Physics performance monitoring for a52f984physmon summary
|
asalzburger
approved these changes
Dec 5, 2023
paulgessinger
added
ready
andiwand
added
automerge
and removed
ready
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.
pre-commit is a framework for managing git-supported pre-commit hooks. It uses a plugin system and auto-installs plugins when run. By default, this does nothing for developers, but if you install pre-commit and run
$ pre-commit installit will register itself as a pre-commit hook with git. It will then yell at you before committing if files are not formatted correctly (I'm also adding a few other things like and end-of-file checker). It only runs on files that are staged, so it should be fast.
One neat thing is that it can run clang-format, and that it installs the correct version of clang-format from PIP! So theoretically, with this, you should get portable automatically correctly formatted commits.