docs: lead the README with what a pull request sees - #545
Closed
shenxianpeng wants to merge 3 commits into
Closed
Conversation
The first screen was a table of contents and a paragraph; the thing that sells the tool — the PR report with every commit, the title, the branch and the author checked against the project's own policy — was nowhere on the page. Now it opens with the value proposition, the PR comment (light and dark), and a four-step quick start that finally includes the GitHub Action. The table of contents moves below the quick start, the stale v2.12.2 pin catches up to v2.14.0, and the CLI demo gif moves to the examples section it illustrates.
Contributor
📝 WalkthroughWalkthroughThe README now presents Commit Check as a versioned policy across terminal, hooks, CI, and AI agents. It updates Quick Start instructions, adds GitHub Actions configuration, removes an obsolete contents entry, and adds a terminal demo. ChangesREADME documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 47-57: Update the README section around the commit-check example
to show a complete valid GitHub Actions workflow, including name, trigger,
permissions with pull-requests write, jobs, runner, checkout, and the
commit-check action step; alternatively label the snippet explicitly as
jobs.<job>.steps. Document that pr-comments is skipped for fork pull requests.
- Around line 50-56: Update the commit-check action example to enable author
validation by adding the author-name and author-email inputs alongside the
existing checks. Clarify the pull-request scope in the README to state that the
action validates one resolved author rather than every commit author in the pull
request.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 566d8898-e6e3-47db-bbc5-7ac8c8c27aa9
⛔ Files ignored due to path filters (2)
assets/pr-comment-dark.pngis excluded by!**/*.pngassets/pr-comment-light.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md
A bare steps fragment is invalid as a workflow file and silently lacks the pull-requests permission pr-comments needs. The snippet is now a whole workflow, enables the author checks the screenshot shows, and says what happens on fork PRs and whose author is validated.
The screenshot showed a redesigned all-scope table that was reverted before shipping; the image and its caption now show the real report — a failures-only table with everything that passed folded away.
|
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
1 participant
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.
The first screen of the README was a table of contents and an overview paragraph; the thing that actually sells the tool — the PR report — was nowhere on the page. Now it opens with:
<picture>, so it matches the viewer's GitHub theme): a failure report with the offending values and each failed rule linked to its documentation, exactly as commit-check-action renders it today.pull-requests: writepermission thatpr-commentsneeds, the author checks, and a note on fork PRs. The stalerev: v2.12.2pin catches up to v2.14.0.The table of contents moves below the quick start instead of being the first thing on the page, and the CLI demo gif moves down to the examples section it illustrates — the terminal view is a detail; the PR view is the pitch.
Asset files:
assets/pr-comment-light.png/assets/pr-comment-dark.png, rendered to match the report layout the action actually posts.