Skip to content

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

Merged
shenxianpeng merged 2 commits into
mainfrom
chore/add-cross-reference-to-hooks
Jun 8, 2026
Merged

docs: add cross-reference to cpp-linter-hooks#442
shenxianpeng merged 2 commits into
mainfrom
chore/add-cross-reference-to-hooks

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Jun 8, 2026

Copy link
Copy Markdown
Member

Add a TIP callout in the README recommending cpp-linter-hooks for users who prefer pre-commit hooks over GitHub Actions, with bidirectional cross-linking between the two projects.

Summary by CodeRabbit

  • Documentation
    • Added a new tip in the README recommending users explore the cpp-linter-hooks pre-commit hook repository as an alternative to GitHub Actions. This option provides consistent C++ linting with clang-format and clang-tidy without requiring manual LLVM installation, delivering a simplified setup experience. Users can now make an informed choice based on their workflow needs.

@shenxianpeng shenxianpeng requested a review from a team as a code owner June 8, 2026 05:05
@shenxianpeng shenxianpeng requested review from 2bndy5 and removed request for a team June 8, 2026 05:05
@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 23a2b330-ca1f-4944-adc2-a4d1d63d1290

📥 Commits

Reviewing files that changed from the base of the PR and between 9a513b1 and f6d026f.

📒 Files selected for processing (1)
  • README.md

Walkthrough

This pull request adds a callout tip to the README recommending users prefer the cpp-linter-hooks pre-commit hook repository over the GitHub Action, highlighting its ability to run clang-format and clang-tidy consistently without requiring manual LLVM installation.

Changes

Documentation Enhancement

Layer / File(s) Summary
README TIP callout for cpp-linter-hooks
README.md
A Markdown TIP callout is added near the introduction, recommending the cpp-linter-hooks pre-commit hook repository as an alternative to the GitHub Action, with a link and brief description of its benefits.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • 2bndy5
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding a cross-reference to the cpp-linter-hooks repository in the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/add-cross-reference-to-hooks

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 8, 2026
Comment thread README.md Outdated
instead of wrapping the entire link with the inline syntax
@2bndy5

2bndy5 commented Jun 8, 2026

Copy link
Copy Markdown
Collaborator

In case your interested, there's a markdown linter pre-commit hook written in rust: rumdl-pre-commit. It works with the config files supported by the original MarkDownLinter (written in JS).

Lately, I've been using deno's builtin markdown formatter, which seems to satisfy most MD linters' rules. And there's a rumdl VSCode extension too.

@shenxianpeng shenxianpeng merged commit 39f903b into main Jun 8, 2026
8 checks passed
@shenxianpeng shenxianpeng deleted the chore/add-cross-reference-to-hooks branch June 8, 2026 05:21
@shenxianpeng

Copy link
Copy Markdown
Member Author

I’m fine with having Markdown linting or not; most of the time it’s easy enough to get Markdown formatting right.

Besides the Rust project mentioned above, I also came across another Rust project: lychee (https://github.com/lycheeverse/lychee).

@2bndy5

2bndy5 commented Jun 8, 2026

Copy link
Copy Markdown
Collaborator

I've also been secretly switching to prek instead of pre-commit. It works much faster, but its not great for python projects where the mypy is used as a pre-commit hook.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants