Use pre-commit for clang-format #175
Conversation
Codecov ReportPatch has no changes to coverable lines. 📢 Thoughts on this report? Let us know!. |
There was a problem hiding this comment.
LGTM, but before merging I think we should add some documentation on how to use the pre-commit when you are developing, similar to what we have in the ROS2 Driver
This way it is easier to use for others.
|
@urmahp I've updated things a bit together with a contributor guideline. |
| * This repo supports [pre-commit](https://pre-commit.com/) e.g. for automatic code formatting. TLDR: | ||
| This will prevent you from committing falsely formatted code: | ||
| ``` | ||
| pipx install pre-commit |
There was a problem hiding this comment.
I think we should state which clang format to install as well.
```suggestion
pipx install pre-commit
sudo apt install clang-format-14
There was a problem hiding this comment.
The clang-format version is specified in the pre-commit job. That's the main reason I switched to pre-commit: clang-format is installed in a python virtualenv with the respective version, so developers (and CI maintainers) don't have to manually install a specific version.
There was a problem hiding this comment.
I wasn't aware of that, nice solution :)
It has bothered be for quite a while that we have so many "code formatting" commit inside our PRs. Using pre-commit enables us to check formatting before we actually push something.