feat: add pre-commit automatic code formatting tool#19
Open
lobis wants to merge 2 commits intoHaarigerHarald:mainfrom
Open
feat: add pre-commit automatic code formatting tool#19lobis wants to merge 2 commits intoHaarigerHarald:mainfrom
lobis wants to merge 2 commits intoHaarigerHarald:mainfrom
Conversation
Owner
|
Thanks, I'm not sure about using all those formatters but clang-format as pre-commit hook is definitely a nice addition. |
Contributor
Author
I can simplify the list for now. Most come from https://github.com/scientific-python/cookie/blob/main/.pre-commit-config.yaml which I would say is the standard for modern scientific Python repositories. I'll finish this PR and tag you when it's done. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add
.pre-commit-config.yamlconfiguration file for pre-commit tool.This will run some code formatting automatically: clang-format, black, formatting cmake files, etc.
The pre-commit bot can be configured to automatically enforce this style in PRs.
I have not formatted the whole repo using this configuration file as it would be a very big diff. If you agree on using pre-commit, we could let the CI bot do it.