Skip to content

Commit

Permalink
Update README to include instructions for pre-commit
Browse files Browse the repository at this point in the history
  • Loading branch information
mmanzoorTT committed Nov 8, 2024
1 parent 6503c70 commit e419db4
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,19 @@ cmake -G Ninja -B build
cmake --build build
cmake --install build
```

### 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/)

0 comments on commit e419db4

Please sign in to comment.