Skip to content

Revise pull request template with clearer sections and contributor checklist #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SharkyBytes merged 1 commit into from
Mar 17, 2026
Merged

Revise pull request template with clearer sections and contributor checklist #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 30 additions & 13 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,40 @@
### Addressed Issues:
<!-- Link the issue this PR addresses -->
Fixes #(issue number)
<!-- What issue does this PR close? -->
Closes #


### Screenshots/Recordings:
<!-- If applicable, add screenshots or recordings to demonstrate the changes -->
## 📝 Description

<!-- A clear and concise description of what this pull request does. -->
<!-- Include any context or background information if necessary. -->

### Additional Notes:
<!-- Add any additional information, context, or notes for reviewers -->
## 🔧 Changes Made

<!-- List the changes you made in this pull request. -->
<!-- For example:
- Fixed a bug in the login flow.
- Added a new feature for user profile customization.
- Updated documentation for API endpoints.
-->

## Checklist
<!-- Mark items with [x] to indicate completion -->
- [ ] My code follows the project's code style and conventions
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings or errors
## 📷 Screenshots or Visual Changes (if applicable)

<!-- Attach screenshots or GIFs to show visual changes, if any. -->
<!-- Drag and drop screenshots here or provide a description of visual updates. -->

## 🤝 Collaboration

<!-- If you collaborated with someone on this pull request, mention their GitHub username or name here. -->
Collaborated with: `@username` (optional)
Comment on lines +24 to +27
Copy link

@coderabbitai coderabbitai bot Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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.

Suggested change
## 🤝 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.



### ✅ Checklist

- [ ] I have read the contributing guidelines.
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] I have added necessary documentation (if applicable).
- [ ] Any dependent changes have been merged and published in downstream modules.
- [ ] I have joined the [Discord server](https://discord.gg/hjUhu33uAn) and I will share a link to this PR with the project maintainers there
- [ ] I have read the [Contributing Guidelines](./CONTRIBUTING.md)


## ⚠️ AI Notice - Important!

Expand Down
Loading