docs: add PR description style guide for agents #21148
Merged
Conversation
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
Adds a style guide documenting PR description patterns observed in the Coder repository. This guide is intended for AI agents to reference when creating PRs, ensuring consistency with project conventions. The guide covers title format (Conventional Commits), description structure (default concise vs. complex structured), what to include (links, performance context, warnings), and what to avoid (test plans, benefits sections). Includes examples from recent merged PRs demonstrating each pattern. Placed in .claude/docs/ alongside other agent-specific documentation (WORKFLOWS.md, ARCHITECTURE.md, etc.) rather than in the main contributing docs, as this is primarily for automated tooling reference. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
08203b2 to
2bc9bec
Compare
Updates the PR style guide to instruct agents to always create draft PRs unless explicitly told otherwise. This allows users to review changes before the PR enters the review queue. Also adds the PR_STYLE_GUIDE.md to the auto-imported docs list in CLAUDE.md so agents will naturally reference it when creating PRs. Changes: - Added "Creating PRs as Draft" section with --draft flag usage - Updated key principles to prioritize draft PRs - Added PR_STYLE_GUIDE.md reference to CLAUDE.md imports 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
bpmct
added a commit
that referenced
this pull request
Dec 7, 2025
Add comprehensive documentation style guide in .claude/docs/ directory following the format established in PR #21148 for PR_STYLE_GUIDE.md. This guide captures observed patterns from existing Coder documentation including: - Research requirements before writing (code verification, permissions, thresholds) - Document structure and organization patterns - Image usage and screenshot guidelines - Writing style and terminology conventions - Code examples and formatting standards - Documentation manifest requirements - Accuracy standards for specific numbers, permissions, and API endpoints - Proactive documentation approach for upcoming features 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
bpmct
added a commit
that referenced
this pull request
Dec 7, 2025
Add comprehensive documentation style guide in .claude/docs/ directory following the format established in PR #21148 for PR_STYLE_GUIDE.md. This guide captures observed patterns from existing Coder documentation including: - Research requirements before writing (code verification, permissions, thresholds) - Document structure and organization patterns - Image usage and screenshot guidelines - Writing style and terminology conventions - Code examples and formatting standards - Documentation manifest requirements - Accuracy standards for specific numbers, permissions, and API endpoints - Proactive documentation approach for upcoming features 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
bpmct
added a commit
that referenced
this pull request
Dec 7, 2025
Add comprehensive documentation style guide in .claude/docs/ directory following the format established in PR #21148 for PR_STYLE_GUIDE.md. This guide captures observed patterns from existing Coder documentation including: - Research requirements before writing (code verification, permissions, thresholds) - Document structure and organization patterns - Image usage and screenshot guidelines - Writing style and terminology conventions - Code examples and formatting standards - Documentation manifest requirements - Accuracy standards for specific numbers, permissions, and API endpoints - Proactive documentation approach for upcoming features 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
bpmct
added a commit
that referenced
this pull request
Dec 7, 2025
Add comprehensive documentation style guide in .claude/docs/ directory following the format established in PR #21148 for PR_STYLE_GUIDE.md. This guide captures observed patterns from existing Coder documentation including: - Research requirements before writing (code verification, permissions, thresholds) - Document structure and organization patterns - Image usage and screenshot guidelines - Writing style and terminology conventions - Code examples and formatting standards - Documentation manifest requirements - Accuracy standards for specific numbers, permissions, and API endpoints - Proactive documentation approach for upcoming features 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
bpmct
added a commit
that referenced
this pull request
Dec 7, 2025
Add comprehensive documentation style guide in .claude/docs/ directory following the format established in PR #21148 for PR_STYLE_GUIDE.md. This guide captures observed patterns from existing Coder documentation including: - Research requirements before writing (code verification, permissions, thresholds) - Document structure and organization patterns - Image usage and screenshot guidelines - Writing style and terminology conventions - Code examples and formatting standards - Documentation manifest requirements - Accuracy standards for specific numbers, permissions, and API endpoints - Proactive documentation approach for upcoming features 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Contributor
|
@codex review |
ibetitsmike
requested changes
Dec 7, 2025
|
Codex Review: Didn't find any major issues. Chef's kiss. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Addresses feedback to avoid including specific PR links that would bloat the context. Replaced PR number references with generic descriptive labels (e.g., 'bugfix', 'dependency update', 'API documentation fix'). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Member
Author
ibetitsmike
reviewed
Dec 8, 2025
ibetitsmike
reviewed
Dec 8, 2025
ibetitsmike
reviewed
Dec 8, 2025
Contributor
ibetitsmike
left a comment
There was a problem hiding this comment.
Some small nitpicks to sort out.
ibetitsmike
approved these changes
Dec 8, 2025
- Remove CONTRIBUTING.md link to avoid context bloat - Clarify dependency update example with generic placeholder - Fix grammar: 'where' -> 'were' 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Rewrite docs correction example to be clearer and more concise. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 a style guide documenting PR description patterns observed in the Coder repository. This guide is intended for AI agents to reference when creating PRs, ensuring consistency with project conventions.
The guide covers title format (Conventional Commits), description structure (default concise vs. complex structured), what to include (links, performance context, warnings), and what to avoid (test plans, benefits sections). Includes examples from recent merged PRs demonstrating each pattern.
Placed in
.claude/docs/alongside other agent-specific documentation (WORKFLOWS.md, ARCHITECTURE.md, etc.) rather than in the main contributing docs, as this is primarily for automated tooling reference.🤖 Generated with Claude Code
Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com