docs: codify PM-level, short PR descriptions in the org PR template#81
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
📝 WalkthroughWalkthroughThe PR replaces the GitHub pull request template with a shorter, more structured format. It introduces HTML comment instructions, "Why" and "What" sections, a "Fixes #" placeholder, and optional single-line metadata fields, removing the previous checkbox-based "Type of change" section. ChangesPR Template Update
Estimated code review effort: 1 (Trivial) | ~2 minutes PoemA rabbit hops through templates new, 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)
17-17: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winMake the issue placeholder explicit.
Fixes #is easy to leave unchanged, which would ship an incomplete issue reference and miss the repo’sFixes#Nconvention. As per the repo contributor guidance, implementing PRs use `Fixes `#N.Suggested wording
-Fixes # +Fixes #<issue-number>🤖 Prompt for 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. In @.github/PULL_REQUEST_TEMPLATE.md at line 17, Update the PR template placeholder in PULL_REQUEST_TEMPLATE so it clearly prompts contributors to provide an actual issue number instead of leaving “Fixes #” unchanged. Replace the ambiguous placeholder with wording that enforces the repo’s “Fixes `#N`” convention, keeping the change in the template text itself so it guides users when filling out pull requests.
🤖 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.
Nitpick comments:
In @.github/PULL_REQUEST_TEMPLATE.md:
- Line 17: Update the PR template placeholder in PULL_REQUEST_TEMPLATE so it
clearly prompts contributors to provide an actual issue number instead of
leaving “Fixes #” unchanged. Replace the ambiguous placeholder with wording that
enforces the repo’s “Fixes `#N`” convention, keeping the change in the template
text itself so it guides users when filling out pull requests.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 4a9acf34-3ac7-41b7-9a48-3e3921c2a5ef
📒 Files selected for processing (1)
.github/PULL_REQUEST_TEMPLATE.md
📜 Review details
⏰ Context from checks skipped due to timeout. (1)
- GitHub Check: Analyze (actions)
Why
You want PR descriptions readable at PM level — short, why/what only, no code detail. The org template is where that expectation should be defined once for every repo and contributor, instead of living only in my instructions.
What
Replaces the org-wide PR template with one that asks for exactly that: a short Why, a short What, the issue link, and optional one-line flags (merge order, breaking change, new dependency, action needed). Drops the type-of-change checkboxes — the PR title already carries the type.
Part of the same policy as devantler-tech/monorepo#2042.