chore(ci): add markdownlint pre-commit hook#124
Merged
Conversation
Add markdownlint-cli2 as a pre-commit hook so the same MD040/MD046 nits coderabbit has been catching on this PR get caught locally at commit time. Scope is narrowed to .github/prompts/**/*.md for now via .markdownlint-cli2.yaml — the docs/, plugins/, and tests/ trees have 24 pre-existing findings that belong to a separate cleanup PR. The hook is glob-driven (pass_filenames: false) so the scope is consistent whether pre-commit invokes it or someone runs it by hand. While here, fix the two MD046 violations in the base triage.md prompt (severity and category token blocks were indented, now fenced as text) and one ambiguous reference in triage-distillery.md to "the four triage sections" (now spells out which four follow KB analysis).
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughThese changes update triage prompt documentation to enforce stricter citation requirements and add markdown linting configuration to validate prompt formatting. New markdownlint and pre-commit hook configuration files enforce code block formatting rules on prompt files in Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
markdownlint-cli2as a pre-commit hook so the MD040/MD046 nits CodeRabbit kept catching on #123 get caught locally at commit time. Scope is narrowed to.github/prompts/**/*.mdfor now via.markdownlint-cli2.yaml— thedocs/,plugins/, andtests/trees have 24 pre-existing findings of the same kind that belong in a separate cleanup PR. The hook is glob-driven (pass_filenames: false) so the scope is the same whether pre-commit invokes it or someone runs it by hand.While here, fixes the two MD046 violations in the base
triage.md(severity and category token blocks were indented, now fenced as text) and tightens one ambiguous reference intriage-distillery.mdto "the four triage sections" — now spells out which four follow KB analysis.This is the followup to #123 that came out of the round-by-round CodeRabbit loop on that PR. The bigger systemic fix lives in
~/.claude/CLAUDE.md(out of repo): a new "Code Review Feedback" section instructs Claude to grep for sibling instances of any reviewer-flagged issue before pushing the fix.Summary by CodeRabbit
Chores
Documentation