add clang-format pre-commit hook (#4599)

* Add a new YAML file (.pre-commit-config.yaml) to set up pre-commit
  hook for clang-format
  * The pre-commit hook is opt-in and needs to be installed in order to
    run automatically
* Update CONTRIBUTING.md with instructions on how to set up and use the
  clang-format linter

Automating the process of running clang-format before committing code
helps to save time by removing the need to fix formatting issues later.

This is a tooling improvement and doesn't change C++ code.
This commit is contained in:
Mayukha Vadari
2023-07-01 18:23:57 -04:00
committed by GitHub
parent 516ffb2147
commit 9c50415ebe
2 changed files with 11 additions and 0 deletions

View File

@@ -121,6 +121,11 @@ this:
You can format individual files in place by running `clang-format -i <file>...`
from any directory within this project.
You can install a pre-commit hook to automatically run `clang-format` before every commit:
```
pip3 install pre-commit
pre-commit install
```
## Avoid