Revise pull request template with clearer sections and contributor checklist#27
Conversation
github-actions
bot
added
no-issue-linked
ci-cd
documentation
WalkthroughThe pull request template is restructured to reorganize sections and update naming conventions. "Addressed Issues" and "Screenshots/Recordings" are renamed to "Description", "Changes Made", and "Screenshots or Visual Changes". A "Collaboration" section is added, and two-column checklist items are removed with updated placeholder text. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/PULL_REQUEST_TEMPLATE.md:
- Around line 24-27: The "Collaborated with: `@username` (optional)" line in the
PR template uses backticks which render the mention as inline code; remove the
surrounding backticks so the entry reads "Collaborated with: `@username`
(optional)" to enable proper GitHub mentions and linking. Update the template
text where the exact string "Collaborated with: `@username` (optional)" appears
to remove the backticks and keep the rest of the line unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: cc6b1cd8-dfae-4dbf-8885-043aca2ed1e8
📒 Files selected for processing (1)
.github/PULL_REQUEST_TEMPLATE.md
| ## 🤝 Collaboration | ||
|
|
||
| <!-- If you collaborated with someone on this pull request, mention their GitHub username or name here. --> | ||
| Collaborated with: `@username` (optional) |
There was a problem hiding this comment.
Fix the collaboration mention format.
The backticks around @username will render it as inline code rather than creating a proper GitHub mention. This prevents the collaborator from being notified and linked.
💬 Proposed fix to enable proper GitHub mentions
-Collaborated with: `@username` (optional)
+Collaborated with: `@username` (optional)Without backticks, @username will create an actual mention that tags the user and creates a clickable link to their profile.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## 🤝 Collaboration | |
| <!-- If you collaborated with someone on this pull request, mention their GitHub username or name here. --> | |
| Collaborated with: `@username` (optional) | |
| ## 🤝 Collaboration | |
| <!-- If you collaborated with someone on this pull request, mention their GitHub username or name here. --> | |
| Collaborated with: `@username` (optional) |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.github/PULL_REQUEST_TEMPLATE.md around lines 24 - 27, The "Collaborated
with: `@username` (optional)" line in the PR template uses backticks which
render the mention as inline code; remove the surrounding backticks so the entry
reads "Collaborated with: `@username` (optional)" to enable proper GitHub mentions
and linking. Update the template text where the exact string "Collaborated with:
`@username` (optional)" appears to remove the backticks and keep the rest of the
line unchanged.
|
LGTM |
2 participants
Updated the pull request template to include new sections for collaboration, screenshots, and an AI notice.
Screenshots/Recordings:
Not applicable. This PR updates the pull request template structure and does not introduce any UI or functional changes.
Additional Notes:
I updated the Pull Request template to improve the contribution workflow and make it easier for contributors to provide structured information when opening a PR.
Changes include:
-> Added clearer sections for description, changes made, and screenshots/recordings
-> Added a collaboration section to acknowledge contributors working together
-> Included an AI usage notice to encourage responsible use of AI tools when contributing
-> Improved the contributor checklist for better PR quality
Additionally, the reference to CONTRIBUTING.md was removed/adjusted as it was causing issues due to the link not resolving correctly in the template.
These updates aim to make PR submissions more consistent and easier for maintainers to review.
Checklist
We encourage contributors to use AI tools responsibly when creating Pull Requests. While AI can be a valuable aid, it is essential to ensure that your contributions meet the task requirements, build successfully, include relevant tests, and pass all linters. Submissions that do not meet these standards may be closed without warning to maintain the quality and integrity of the project. Please take the time to understand the changes you are proposing and their impact.
Summary by CodeRabbit