Skip to content

Commit

Permalink
docs(contribute.md): add instructions for clang-tidy
Browse files Browse the repository at this point in the history
Signed-off-by: Max SCHMELLER <[email protected]>
  • Loading branch information
mojomex committed Oct 3, 2024
1 parent 1df338b commit f208a97
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Before submitting your contributions, please take a moment to review our guideli
pre-commit install
```

- Set up your IDE to use Clang-Tidy with the `.clang-tidy` configuration found in the repository root
- Docs are found at [tier4.github.io/nebula](https://tier4.github.io/nebula)

## How to Contribute
Expand Down Expand Up @@ -66,6 +67,7 @@ Hotfix PRs should be against the `master` branch.
A good PR fulfills all of the following:

- passes pre-commit
- conforms to the repo's `.clang-tidy` and `.clang-format`
- passes all CI checks
- a single clearly stated goal
- every line changed directly contributes to that goal
Expand Down

0 comments on commit f208a97

Please sign in to comment.