Skip to content

docs: add cross-reference to cpp-linter-hooks #442

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.

Sign up for GitHub

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

Merged
shenxianpeng merged 2 commits into from
Jun 8, 2026
Merged

docs: add cross-reference to cpp-linter-hooks #442

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebe1b5e
docs: add cross-reference to cpp-linter-hooks
shenxianpeng Jun 8, 2026
f6d026f
move inline syntax into link's text
2bndy5 Jun 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ to collect feedback provided in the form of
workflow [`step-summary`][step-summary], and Pull Request reviews (with
[`tidy-review`][tidy-review] or [`format-review`][format-review]).

> [!TIP]
> Prefer pre-commit hooks over GitHub Actions? Check out
> [**cpp-linter-hooks**](https://github.com/cpp-linter/cpp-linter-hooks) —
> a pre-commit hook repository that runs `clang-format` and `clang-tidy`
> consistently on developer machines and in CI, with no manual LLVM installs.

## Usage

Create a new GitHub Actions workflow in your project, e.g. at [.github/workflows/cpp-linter.yml](https://github.com/cpp-linter/cpp-linter-action/blob/main/.github/workflows/cpp-linter.yml)
Expand Down