Skip to content

Commit

Permalink
Add note about pre-commit to README
Browse files Browse the repository at this point in the history
  • Loading branch information
alexdewar committed Jun 19, 2023
1 parent feba9bb commit 6566502
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,24 @@ cmake --build --preset='debug-build-linux'
ctest --preset='core-test-linux'
```

All available options are defined using CMake *presets* in the `CMakePresets.json` file, which also declare *build presets* to be used via the CMake command line arguments.
All available options are defined using CMake *presets* in the `CMakePresets.json` file,
which also declare *build presets* to be used via the CMake command line arguments.

### Optional: Running `pre-commit` hooks

It is recommended that developers install [`pre-commit`](https://pre-commit.com/) to
make use of [the hooks](./.pre-commit-config.yaml) we have installed for this
repository. (Note that this step is only for Health-GPS developers, not end users!)

Once you have [installed `pre-commit`](https://pre-commit.com/#installation), you should
install the hooks into your local clone of the Health-GPS repository, like so:

```cmd
> pre-commit install
```

Now, every time attempt to make a git commit, your changes will be checked against the
`pre-commit` hooks.

# License

Expand Down

0 comments on commit 6566502

Please sign in to comment.