Repository navigation
docs(github): ask for one visual aid in pull request bodies - #321
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
It is a self-contained docs-only edit to the PR template with consistent, grammatically correct guidance and no functional or formatting issues.
Review effort: Balanced
Findings: None
What changed in this PR
This PR revises the repository's GitHub pull request template (.github/pull_request_template.md) to steer contributors toward shorter, more focused PR bodies. It replaces the open-ended "Change" prompt with guidance to write one outcome sentence plus a single visual aid (screenshot/recording, Mermaid diagram, table, or code sample), and trims the validation guidance comment to drop the longer instructions while adding an "Unverified:" convention for skipped proof. It is a docs-only change with no functional code impact.
Changes:
- Rewrote the "Change" section comment to request one outcome sentence and one visual aid, and to exclude test counts, command logs, file lists, and review history.
- Condensed the validation guidance comment and introduced a single
Unverified:line convention for skipped or unavailable proof.
| File | Description |
|---|---|
.github/pull_request_template.md |
Updates the two guidance HTML comments to ask for a concise outcome + visual aid and a condensed validation note. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Change
The PR template now asks for one outcome sentence and one visual aid, and keeps test counts, command logs, file lists and review history out.
Validation
./gradlew markdownCheckWritten by an agent (Claude Code, Opus 5.5)