Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add contribution guidelines #202

Merged
merged 7 commits into from
Nov 11, 2024
Prev Previous commit
Next Next commit
docs(contribute.md): add instructions for clang-tidy
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
mojomex committed Oct 3, 2024
commit f208a977258d9d40b42a7d44c045233ee6e91863
2 changes: 2 additions & 0 deletions docs/contribute.md
Original file line number Diff line number Diff line change
@@ -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
@@ -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