docs: add pull request template with testing checklist#980
Conversation
17af142 to
485ab76
Compare
23b7fdf to
ab492fd
Compare
|
I have to admit that I don't like long PR templates with lots of check boxes. I find it annoying to check a bunch of checkboxes every time I create a PR. What problems is the template addressing? Are we adding the PR template because we got bad PRs? Or are we adding a template just because some quality check tool wants it? I would rather invest in better contribution documentation and automated checks. The template could be reduced to something like this: |
ab492fd to
88eb7a7
Compare
|
@Mergifyio rebase |
Add .github/PULL_REQUEST_TEMPLATE.md with What/Why sections and a single CONTRIBUTING.md guidelines checkbox. Kept minimal per maintainer preference. Closes: python-wheel-build#968 Co-Authored-By: Claude <claude@anthropic.com> Signed-off-by: smoparth <smoparth@redhat.com>
✅ Branch has been successfully rebased |
88eb7a7 to
4e9eb53
Compare
📝 WalkthroughWalkthroughAdded a pull request template file at Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)
11-11: Optional: Consider more active checkbox wording.The current wording is clear, but you might consider a slightly more active phrasing to make it more personal to the contributor:
-- [ ] PR follows [CONTRIBUTING.md](https://github.com/python-wheel-build/fromager/blob/main/CONTRIBUTING.md) guidelines +- [ ] I have read and followed the [CONTRIBUTING.md](https://github.com/python-wheel-build/fromager/blob/main/CONTRIBUTING.md) guidelinesThis is purely stylistic—the current version is perfectly acceptable.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/PULL_REQUEST_TEMPLATE.md at line 11, The PR template checkbox "[ ] PR follows [CONTRIBUTING.md](https://github.com/python-wheel-build/fromager/blob/main/CONTRIBUTING.md) guidelines" is phrased passively; update the checkbox text in .github/PULL_REQUEST_TEMPLATE.md to a more active, contributor-focused wording such as "I followed the CONTRIBUTING.md guidelines" or "I have followed the CONTRIBUTING.md guidelines" so contributors affirm ownership when checking the box—replace the existing checkbox line accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In @.github/PULL_REQUEST_TEMPLATE.md:
- Line 11: The PR template checkbox "[ ] PR follows
[CONTRIBUTING.md](https://github.com/python-wheel-build/fromager/blob/main/CONTRIBUTING.md)
guidelines" is phrased passively; update the checkbox text in
.github/PULL_REQUEST_TEMPLATE.md to a more active, contributor-focused wording
such as "I followed the CONTRIBUTING.md guidelines" or "I have followed the
CONTRIBUTING.md guidelines" so contributors affirm ownership when checking the
box—replace the existing checkbox line accordingly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 1c69844a-955d-44f6-a57a-8a6e79f15d83
📒 Files selected for processing (1)
.github/PULL_REQUEST_TEMPLATE.md
Add .github/PULL_REQUEST_TEMPLATE.md with concise What/Why sections and checklists for testing (hatch commands) and coding standards (type annotations, docstrings, commit format). The template serves as a lightweight reminder of CONTRIBUTING.md requirements at PR submission time.
Closes: #968
Summary by CodeRabbit