Skip to content

Commit

Permalink
Added Precommit installation instructions to Docs and precommit-insta… (
Browse files Browse the repository at this point in the history
#97)

* Added Precommit installation instructions to Docs and precommit-install CMake target

* Removed pre-commit CMake target

* Pull from main to update build task
  • Loading branch information
vprajapati-tt authored Jul 3, 2024
1 parent 8927967 commit 9e621e3
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/src/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,22 @@ source env/activate
cmake --build build -- clang-tidy
```

### Pre-Commit
Pre-Commit applies a git hook to the local repository such that linting is checked and applied on every `git commit` action. Install from the root of the repository using:

```bash
source env/activate
pre-commit install
```

If you have already committed before installing the pre-commit hooks, you can run on all files to "catch up":

```bash
pre-commit run --all-files
```

For more information visit [pre-commit](https://pre-commit.com/)

## Docs

```bash
Expand Down

0 comments on commit 9e621e3

Please sign in to comment.