Skip to content

docs: clarify pr-creator body guidance#92

Merged
chenjiahan merged 1 commit into
mainfrom
chenjiahan/docs-pr-creator-body-guidance
Jul 2, 2026
Merged

docs: clarify pr-creator body guidance#92
chenjiahan merged 1 commit into
mainfrom
chenjiahan/docs-pr-creator-body-guidance

Conversation

@chenjiahan

Copy link
Copy Markdown
Member

This PR updates the internal pr-creator skill to prefer concise, review-oriented PR descriptions.
The new guidance focuses summaries on why the change matters, what changed, and reviewer-important impact.

Copilot AI review requested due to automatic review settings July 2, 2026 09:27
@chenjiahan chenjiahan merged commit 71782e7 into main Jul 2, 2026
5 checks passed
@chenjiahan chenjiahan deleted the chenjiahan/docs-pr-creator-body-guidance branch July 2, 2026 09:29

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refines the internal pr-creator skill’s guidance for writing PR bodies, emphasizing concise, review-oriented descriptions that focus on why the change matters, what changed, and reviewer-relevant impact.

Changes:

  • Updates the PR body guidance to prefer 1–4 short standalone sentences for typical changes, centered on rationale, change summary, and review impact.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: b1052394-83ac-4880-b7f2-d4b73abd5133

📥 Commits

Reviewing files that changed from the base of the PR and between 1b3787a and 3d67092.

📒 Files selected for processing (1)
  • .agents/skills/pr-creator/SKILL.md

📝 Walkthrough

Walkthrough

This change updates a single line in the pr-creator skill's documentation file, revising the guidance for writing pull request body descriptions. The instruction now specifies using 1–4 short standalone sentences for typical changes, replacing the previous guidance of a compact paragraph or 2–4 bullets.

Changes

File Change Summary
.agents/skills/pr-creator/SKILL.md Updated PR body brevity guidance from "compact paragraph or 2–4 bullets" to "1–4 short standalone sentences"

Sequence Diagram(s)

Not applicable for this documentation-only change.

Compact Metadata
Type: Documentation
Impact: Low
Files changed: 1
Lines changed: +1/-1

Related Issues: None specified.

Related PRs: None specified.

Suggested Labels: documentation

Suggested Reviewers: None specified.

Poem
A single line, refined and neat,
Four sentences, short and sweet.
No more bullets scattered wide,
Just clear words, side by side.
A tiny hop, but well complete. 🐇

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chenjiahan/docs-pr-creator-body-guidance

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.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants