Skip to content

feat: add policy presets and adoption kit#420

Open
shenxianpeng wants to merge 1 commit into
mainfrom
feature/policy-presets-adoption-kit
Open

feat: add policy presets and adoption kit#420
shenxianpeng wants to merge 1 commit into
mainfrom
feature/policy-presets-adoption-kit

Conversation

@shenxianpeng
Copy link
Copy Markdown
Member

@shenxianpeng shenxianpeng commented May 29, 2026

Summary

Add Recommended Policy Presets + Adoption Kit so users don't have to guess among 20+ config options.

What's included

Three policy presets (presets/)

Preset For Inherit from
Minimal Personal / solo projects github:commit-check/commit-check:presets/minimal.toml
Recommended Open source projects github:commit-check/commit-check:presets/recommended.toml
Strict Enterprise / regulated teams github:commit-check/commit-check:presets/strict.toml

Adoption Kit (docs/presets.rst)

  • Side-by-side comparison table of all 17 checks across the three presets
  • Quick Start: 30 seconds to configure with a clear decision tree
  • Override examples (presets are just inherit_from — local overrides on top)
  • Air-gapped / offline usage guide
  • FAQ

Wired into existing docs

  • README — new tip box + "Use a Policy Preset" section at the top of Configuration
  • docs/configuration.rst — tip linking to presets for new users
  • docs/index.rst — presets page added to toctree (second after self)

Design decisions

  • Uses inherit_from (existing mechanism) — no new code
  • All three preset files are committed to this repo under presets/
  • Presets are versionable (pin to tag: @v2.6.0:presets/...)
  • Non-breaking: existing custom configs continue working

@shenxianpeng shenxianpeng requested a review from a team as a code owner May 29, 2026 06:11
@netlify
Copy link
Copy Markdown

netlify Bot commented May 29, 2026 •
edited
Loading

✅ Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit c13e144
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6a21e92dc8f712000876a206
😎 Deploy Preview https://deploy-preview-420--commit-check.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 29, 2026 •
edited
Loading

Warning

Review limit reached

@shenxianpeng, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 13 minutes and 44 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fb6b8ec3-969a-4d53-9415-19e1c362a306

📥 Commits

Reviewing files that changed from the base of the PR and between 91ec64e and c13e144.

📒 Files selected for processing (7)
  • README.rst
  • docs/configuration.rst
  • docs/index.rst
  • docs/presets.rst
  • presets/minimal.toml
  • presets/recommended.toml
  • presets/strict.toml
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/policy-presets-adoption-kit

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 documentation Improvements or additions to documentation enhancement New feature or request labels May 29, 2026
@shenxianpeng
feat: add policy presets and adoption kit
c13e144 
Add three ready-to-use policy presets (Minimal, Recommended, Strict) so
users don't have to guess among 20+ config options:

- presets/minimal.toml — personal/solo projects
- presets/recommended.toml — open source projects
- presets/strict.toml — enterprise/regulated teams

Add docs/presets.rst with a side-by-side comparison, quick-start guide,
override examples, offline usage, and FAQ.

Wire presets into README, docs/index.rst, and docs/configuration.rst.
@shenxianpeng shenxianpeng force-pushed the feature/policy-presets-adoption-kit branch from c41bd6e to c13e144 Compare June 4, 2026 21:07
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Jun 4, 2026

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

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

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@shenxianpeng