docs: improve PR template with Related Issue and Type of Change sections#7703
Open
dipanshurdev wants to merge 1 commit intousebruno:mainfrom
Open
docs: improve PR template with Related Issue and Type of Change sections#7703dipanshurdev wants to merge 1 commit intousebruno:mainfrom
dipanshurdev wants to merge 1 commit intousebruno:mainfrom
Conversation
dipanshurdev
requested review from
bijin-bruno,
helloanoop,
lohit-bruno and
naman-bruno
as code owners
Contributor
WalkthroughUpdated the GitHub pull request template to include new "Related Issue" and "Type of Change" sections with checkbox options for categorizing contributions, while preserving the existing "Contribution Checklist" section. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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}
Contributor
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)
26-26:⚠️ Potential issue | 🟡 MinorMake issue-linking conditional to avoid false blocking
This checklist item reads as mandatory, but not every PR has a related issue (including internal process/docs changes). Consider making it conditional.
Suggested tweak
-- [ ] **Create an issue and link to the pull request.** +- [ ] **If applicable, I have linked the related issue to this pull request.**🤖 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 26, The checklist item "[ ] **Create an issue and link to the pull request.**" should be made conditional/optional; update the PR template so that this line reads something like "[ ] **If applicable: create an issue and link to the pull request.**" or move it into an "Optional" section, ensuring the wording includes "if applicable" to avoid blocking PRs that legitimately have no related issue (refer to the exact checklist string to locate and change it).
🧹 Nitpick comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)
11-17: Prefer checkbox selection over deleting optionsAsking contributors to delete lines adds friction and noisy diffs. Prefer “check all that apply” for this section.
Suggested tweak
-<!-- Please delete options that are not relevant. --> +<!-- Check all options that apply. -->🤖 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 11 - 17, Replace the “Please delete options that are not relevant.” instruction and the current dash-list of options in .github/PULL_REQUEST_TEMPLATE.md with an explicit checkbox checklist that contributors should check instead of deleting; update the options (the list items shown in the template) to use unchecked checkboxes (e.g., - [ ] ) and change the accompanying guidance text to “Check all that apply” (or similar) so contributors mark applicable boxes rather than removing lines.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In @.github/PULL_REQUEST_TEMPLATE.md:
- Line 26: The checklist item "[ ] **Create an issue and link to the pull
request.**" should be made conditional/optional; update the PR template so that
this line reads something like "[ ] **If applicable: create an issue and link to
the pull request.**" or move it into an "Optional" section, ensuring the wording
includes "if applicable" to avoid blocking PRs that legitimately have no related
issue (refer to the exact checklist string to locate and change it).
---
Nitpick comments:
In @.github/PULL_REQUEST_TEMPLATE.md:
- Around line 11-17: Replace the “Please delete options that are not relevant.”
instruction and the current dash-list of options in
.github/PULL_REQUEST_TEMPLATE.md with an explicit checkbox checklist that
contributors should check instead of deleting; update the options (the list
items shown in the template) to use unchecked checkboxes (e.g., - [ ] ) and
change the accompanying guidance text to “Check all that apply” (or similar) so
contributors mark applicable boxes rather than removing lines.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 32cfe8d9-1461-4e6c-87d5-9924aef5fd75
📒 Files selected for processing (1)
.github/PULL_REQUEST_TEMPLATE.md
7 tasks
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
1 participant
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 updates the Pull Request template to improve the contribution workflow.
These changes help maintainers by:
Related Issue
None (Internal process improvement)
Type of Change
Summary by CodeRabbit