feat: add Pull Request template#241
Merged
PGijsbers merged 4 commits intoopenml:mainfrom Mar 10, 2026
Merged
Conversation
Contributor
|
Caution Review failedPull request was closed or merged during review WalkthroughA new pull request template file was added at 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). 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 |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Consider tailoring the checklist so that some items are conditional (e.g., commenting code, adding tests) or grouped by change type, to avoid forcing contributors with simple or non-code changes to mark irrelevant boxes.
- You might want to add a short 'Motivation/Context' or 'Background' section to help reviewers quickly understand why the change is needed in addition to what was changed.
- If you expect PRs to frequently reference multiple issues or link to discussions, consider clarifying the 'Fixes # (issue)' line to show examples for multiple references (e.g., 'Fixes #123, relates to #456').
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider tailoring the checklist so that some items are conditional (e.g., commenting code, adding tests) or grouped by change type, to avoid forcing contributors with simple or non-code changes to mark irrelevant boxes.
- You might want to add a short 'Motivation/Context' or 'Background' section to help reviewers quickly understand why the change is needed in addition to what was changed.
- If you expect PRs to frequently reference multiple issues or link to discussions, consider clarifying the 'Fixes # (issue)' line to show examples for multiple references (e.g., 'Fixes #123, relates to #456').Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
.github/PULL_REQUEST_TEMPLATE.md (2)
19-20: Replace the genericTest A/Test Bplaceholders with meaningful test-type options.
Test AandTest Bprovide no guidance to contributors. Typical PR templates enumerate the actual test categories relevant to the project.♻️ Proposed improvement
-- [ ] Test A -- [ ] Test B +- [ ] Unit tests +- [ ] Integration tests +- [ ] Manual / exploratory testing🤖 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 19 - 20, Replace the generic checklist items "- [ ] Test A" and "- [ ] Test B" in the PR template with concrete test-type options that match this repo (e.g., unit tests, integration tests, end-to-end tests, linting/formatting checks, manual QA), updating the checklist lines so contributors can select the specific applicable test categories instead of vague placeholders; locate the two placeholder lines ("- [ ] Test A" and "- [ ] Test B") and substitute them with the meaningful options used by the project.
22-22: Remove the trailing colon from# Checklist:for consistency with the other headings.📝 Proposed fix
-# Checklist: +# Checklist🤖 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 22, The heading "# Checklist:" includes a trailing colon that is inconsistent with other headings; edit the pull request template to remove the colon so the heading reads "# Checklist" (locate the string "# Checklist:" in .github/PULL_REQUEST_TEMPLATE.md and update it to "# Checklist").
🤖 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:
- Line 8: Change the "## Type of change" heading to a top-level H1 ("# Type of
change") so it matches the other top-level sections like "# Description", "# How
Has This Been Tested?", and "# Checklist:" in the PULL_REQUEST_TEMPLATE.md;
update the single-line header text exactly from "## Type of change" to "# Type
of change" to preserve consistency across the file.
---
Nitpick comments:
In @.github/PULL_REQUEST_TEMPLATE.md:
- Around line 19-20: Replace the generic checklist items "- [ ] Test A" and "- [
] Test B" in the PR template with concrete test-type options that match this
repo (e.g., unit tests, integration tests, end-to-end tests, linting/formatting
checks, manual QA), updating the checklist lines so contributors can select the
specific applicable test categories instead of vague placeholders; locate the
two placeholder lines ("- [ ] Test A" and "- [ ] Test B") and substitute them
with the meaningful options used by the project.
- Line 22: The heading "# Checklist:" includes a trailing colon that is
inconsistent with other headings; edit the pull request template to remove the
colon so the heading reads "# Checklist" (locate the string "# Checklist:" in
.github/PULL_REQUEST_TEMPLATE.md and update it to "# Checklist").
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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:
- Line 21: Remove the trailing colon from the inconsistent top-level heading "#
Checklist:" and change it to "# Checklist" so it matches the style of other
headings (e.g., "# Description", "# Type of change", "# How Has This Been
Tested?"); update the heading text in the template where "# Checklist:" appears
to "# Checklist" (search for the exact string "# Checklist:" to locate the
spot).
- Line 5: Replace the incorrect placeholder "Fixes # (issue)" in the pull
request template with a correct example pattern that will trigger GitHub
auto-closing (remove the space after the #); update the line containing the
literal "Fixes # (issue)" to a clear example such as "Fixes `#123`" or "Fixes
`#123`, `#456`" so contributors can copy-paste a working issue link; ensure the
template still includes the explanatory text but uses the corrected example
pattern wherever "Fixes # (issue)" appears.
Contributor
Author
|
Hi @PGijsbers, I've added the Pull Request template as discussed in #83. It includes standard sections for Description, Type of Change, and Checklist to streamline future contributions. |
PGijsbers
requested changes
Feb 27, 2026
Contributor
PGijsbers
left a comment
PGijsbers
left a comment
There was a problem hiding this comment.
Hey! Thanks for taking the effort to make a contribution to this project.
To avoid a long back and forth, I suggested some changes directly.
After that I think it's a fair starting point to merge.
Let me know if you disagree with any of the proposed changes.
PGijsbers
approved these changes
Mar 10, 2026
Contributor
|
Thanks again for your contribution. Because the PR was going stale, I revised the template myself so we can go ahead and merge this! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a [.github/PULL_REQUEST_TEMPLATE.md] to standardize contributions. It ensures that all future PRs include necessary details like a summary of changes, testing instructions, and a compliance checklist.
Fixes #83
Type of change
How Has This Been Tested?
Checklist: