docs(pr-writer): Improve PR description guidance#158
Merged
Conversation
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
dcramer
force-pushed
the
docs/improve-pr-writer-guidance
branch
2 times, most recently
from
e2108f6 to
bc8507e
Compare
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
There are 2 total unresolved issues (including 1 from previous review).
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit bc8507e. Configure here.
dcramer
force-pushed
the
docs/improve-pr-writer-guidance
branch
from
bc8507e to
6426f94
Compare
Rewrite the runtime guidance around full-branch PR summaries, adaptive body shapes, and optional reviewer aids. Update the spec to capture the expanded contract around breaking changes, diagrams, schemas, and validation noise. Co-Authored-By: Codex <noreply@openai.com>
dcramer
force-pushed
the
docs/improve-pr-writer-guidance
branch
from
6426f94 to
14e1594
Compare
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
pr-writerskill now steers PR descriptions toward the full branch diff instead of the latest commit or a generated template. Small changes should stay short, while breaking changes, schema updates, generated diffs, and workflow changes get the extra context reviewers need.Schemas, before/after examples, Mermaid diagrams, rollout notes, and review order are treated as optional reviewer aids, not default sections. Routine validation stays out of PR bodies unless it changes review risk.