Add Pull Request (PR) template (#5826) #5906
Conversation
WalkthroughA Pull Request template file is added to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✨ 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 |
|
Automated Quality Checks (from CONTRIBUTING minimum standards)
These checks are a best-effort automation and do not replace human review. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md (3)
58-61: Clarify the deletion vs. checkbox instruction.The instruction "Please delete one of the following lines:" is ambiguous. Contributors might be confused about whether they should:
- Check a box (standard checkbox behavior), or
- Delete the line they don't need and manually edit the text
Consider rephrasing to make the intended interaction clear. For example: "Select one option below by keeping only the line that applies and removing the other" or provide clearer guidance on the expected format.
Suggested rephrase:
-Please delete one of the following lines: +Select one option by keeping the applicable statement and removing the other: - [ ] The packages around my addition still meet the Quality Standards. - [ ] I removed the following packages around my addition: (please give a short reason for each removal)
24-24: Minor: Consider shortening the section header.Line 24's header is somewhat verbose. A more concise version would improve readability without losing meaning.
-## We want to ensure high quality of the packages. Make sure that you've checked the boxes below before sending a pull request. +## Quality Standards Checklist
63-63: Minor style note: Consider a more formal closing.The static analysis tool flagged "awesome" as informal. While the celebratory tone is friendly, a slightly more formal closing may be more appropriate for a template document (e.g., "Thanks for contributing!" or "We appreciate your contribution!"). This is entirely optional and depends on the repository's tone.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md
[style] ~63-~63: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...ch removal) Thanks for your PR, you're awesome! 😎
(AWESOME)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (1)
.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md (1)
1-23: Well-structured template with clear sections.The initial sections (description, related issues, screenshots, change type, and standard checklist) are clearly written and provide helpful guidance to contributors. Formatting is clean with good use of emojis to make sections visually scannable.
|
This PR only adds a documentation file (.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md). The "PR Quality Check" failure is due to missing docstring/test coverage, which doesn’t apply to Markdown files. |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (1)
.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md (1)
1-61: Comprehensive quality and contribution checklist — well structured.The template effectively enforces the project's quality standards by including:
- Clear sections for description, related issues, and change type
- Comprehensive checklists referencing the Contribution Guidelines and Quality Standards
- Links section for easy reference to package repositories (forge, pkg.go.dev, goreportcard, coverage)
- Validation for alphabetical ordering and package descriptions
- Thoughtful reminder to check nearby packages for quality compliance
This aligns well with issue #5826 objectives and should help standardize PR submissions and improve maintainer review efficiency.
| ## Description of changes | ||
| Please describe the changes made in this Pull Request and why they are necessary. | ||
|
|
||
| ## Related issues | ||
| Fixes #5826 |
There was a problem hiding this comment.
🧩 Analysis chain
Verify GitHub template path recognition.
The file is placed at .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md, but GitHub's PR template auto-detection typically looks for lowercase filenames at .github/pull_request_template.md or .github/PULL_REQUEST_TEMPLATE/pull_request_template.md. The uppercase filename may prevent GitHub from automatically loading this template when creating PRs.
Per the PR objectives, the template was intended for .github/pull_request_template.md (lowercase). Verify that GitHub recognizes templates at the current path with an uppercase filename:
🌐 Web query:
GitHub pull request template path recognition case sensitivity
💡 Result:
Short answer: GitHub uses the exact filenames/paths shown in the docs, and repository paths are treated with Git's case-sensitivity rules — so you should use the documented names (e.g. pull_request_template.md, .github/pull_request_template.md or a PULL_REQUEST_TEMPLATE/ directory) with the same casing. If your repo (or contributor machine) is on a case-insensitive filesystem you can be misled locally, but the canonical matching on Git/GitHub expects the documented casing. [1][2]
Sources:
- GitHub Docs — Creating a pull request template for your repository. [1]
- GitHub Enterprise Docs (same file-location rules). [2]
Rename file to use lowercase filename for GitHub template auto-detection.
The file must be renamed from .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md to .github/PULL_REQUEST_TEMPLATE/pull_request_template.md (lowercase filename). GitHub applies Git's case-sensitivity rules to repository paths and expects documented naming conventions. The current uppercase filename prevents GitHub from auto-loading the template when creating PRs.
🤖 Prompt for AI Agents
.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md lines 1-5: the PR
template filename uses uppercase and GitHub won't auto-detect it; rename the
file to use lowercase by moving/renaming
.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md to
.github/PULL_REQUEST_TEMPLATE/pull_request_template.md and update any references
or CI paths that point to the old name so the repository uses the lowercase
filename for GitHub template auto-detection.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md
[style] ~37-~37: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...tion is used to attempt to catch issues prior to releasing this package to end-users. #...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~41-~41: The official name of this software platform is spelled with a capital “H”.
Context: ...e to ease the review - [ ] forge link (github.com, gitlab.com, etc): - [ ] pkg.go.dev...
(GITHUB)
[style] ~41-~41: In American English, abbreviations like “etc.” require a period.
Context: ...[ ] forge link (github.com, gitlab.com, etc): - [ ] pkg.go.dev: - [ ] goreportcard....
(ETC_PERIOD)
[style] ~63-~63: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...ch removal) Thanks for your PR, you're awesome! 😎 2 changes: 1 addition & 1...
(AWESOME)
[uncategorized] ~65-~65: The official name of this software platform is spelled with a capital “H”.
Context: ...: 2 changes: 1 addition & 1 deletion 2 .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMP...
(GITHUB)
[style] ~95-~95: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...tion is used to attempt to catch issues prior to releasing this package to end-users. ##...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~97-~97: The official name of this software platform is spelled with a capital “H”.
Context: ...ge to ease the review - [ ] forge link (github.com, gitlab.com, etc): - [ ] pkg.go.dev...
(GITHUB)
[style] ~97-~97: In American English, abbreviations like “etc.” require a period.
Context: ...[ ] forge link (github.com, gitlab.com, etc): - [ ] pkg.go.dev: - [ ] goreportcard....
(ETC_PERIOD)
[style] ~112-~112: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...ch removal) Thanks for your PR, you're awesome! 😎
(AWESOME)
🪛 markdownlint-cli2 (0.18.1)
.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md
67-67: Hard tabs
Column: 27
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 45
(MD010, no-hard-tabs)
68-68: Multiple headings with the same content
(MD024, no-duplicate-heading)
70-70: Multiple headings with the same content
(MD024, no-duplicate-heading)
72-72: Multiple headings with the same content
(MD024, no-duplicate-heading)
74-74: Multiple headings with the same content
(MD024, no-duplicate-heading)
79-79: Multiple headings with the same content
(MD024, no-duplicate-heading)
85-85: Multiple headings with the same content
(MD024, no-duplicate-heading)
96-96: Multiple headings with the same content
(MD024, no-duplicate-heading)
101-101: Multiple headings with the same content
(MD024, no-duplicate-heading)
105-105: Multiple headings with the same content
(MD024, no-duplicate-heading)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (1)
.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md (1)
1-1: The review comment is based on incorrect information about GitHub's PR template detection.GitHub's documentation confirms that both the uppercase
PULL_REQUEST_TEMPLATEdirectory form (for multiple templates) and the lowercasepull_request_template.mdsingle-file form are accepted and will be auto-detected. The current file path.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.mdfollows GitHub's documented pattern for organizing multiple PR templates and does not require renaming to lowercase. No changes are needed.Likely an incorrect or invalid review comment.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)
39-44: Fix minor grammar and punctuation issues.The static analysis tools flagged a few minor style issues:
- Line 41: "etc)" should include a period per American English conventions: "etc):"
- Line 37: "prior to" is verbose; consider "before" for conciseness
These are minor refinements but worth addressing for polish.
Apply this diff:
- [ ] forge link (github.com, gitlab.com, etc): + [ ] forge link (github.com, gitlab.com, etc.):And optionally:
- [ ] Continuous integration is used to attempt to catch issues prior to releasing this package to end-users. + [ ] Continuous integration is used to attempt to catch issues before releasing this package to end-users.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/PULL_REQUEST_TEMPLATE.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/PULL_REQUEST_TEMPLATE.md
[uncategorized] ~65-~65: The official name of this software platform is spelled with a capital “H”.
Context: ...: 2 changes: 1 addition & 1 deletion 2 .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMP...
(GITHUB)
[style] ~95-~95: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...tion is used to attempt to catch issues prior to releasing this package to end-users. ##...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~97-~97: The official name of this software platform is spelled with a capital “H”.
Context: ...ge to ease the review - [ ] forge link (github.com, gitlab.com, etc): - [ ] pkg.go.dev...
(GITHUB)
[style] ~97-~97: In American English, abbreviations like “etc.” require a period.
Context: ...[ ] forge link (github.com, gitlab.com, etc): - [ ] pkg.go.dev: - [ ] goreportcard....
(ETC_PERIOD)
[style] ~112-~112: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...ch removal) Thanks for your PR, you're awesome! 😎
(AWESOME)
🪛 markdownlint-cli2 (0.18.1)
.github/PULL_REQUEST_TEMPLATE.md
67-67: Hard tabs
Column: 27
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 45
(MD010, no-hard-tabs)
68-68: Multiple headings with the same content
(MD024, no-duplicate-heading)
70-70: Multiple headings with the same content
(MD024, no-duplicate-heading)
72-72: Multiple headings with the same content
(MD024, no-duplicate-heading)
74-74: Multiple headings with the same content
(MD024, no-duplicate-heading)
79-79: Multiple headings with the same content
(MD024, no-duplicate-heading)
85-85: Multiple headings with the same content
(MD024, no-duplicate-heading)
96-96: Multiple headings with the same content
(MD024, no-duplicate-heading)
101-101: Multiple headings with the same content
(MD024, no-duplicate-heading)
105-105: Multiple headings with the same content
(MD024, no-duplicate-heading)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)
1-63: Remove corrupted duplicate content (lines 64–112) from the template file.The review comment's concerns about filename case-sensitivity are incorrect—GitHub treats pull-request template filenames as case-insensitive, and the current path
.github/PULL_REQUEST_TEMPLATE.mdis correct and recognized by GitHub.However, the file contains a critical issue: lines 64–112 are duplicated template content mixed with diff metadata (file path references, "Copied!" markers, diff table headers with hard tabs). This appears to be accidental copy-paste of diff output into the template. These 49 lines must be deleted, leaving only lines 1–63 as the legitimate template.
Likely an incorrect or invalid review comment.
| 2 changes: 1 addition & 1 deletion 2 | ||
| .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md | ||
| Copied! | ||
| Original file line number Diff line number Diff line change | ||
| ## Description of changes | ||
| Please describe the changes made in this Pull Request and why they are necessary. | ||
| ## Related issues | ||
| Fixes #5826 | ||
| ## Screenshots (if applicable) | ||
| _Add screenshots or GIFs here to demonstrate visual changes._ | ||
| ## Type of change | ||
| - [ ] 🐛 Bug fix | ||
| - [ ] ✨ New feature | ||
| - [ ] 🧹 Code enhancement / refactor | ||
| - [ ] 📝 Documentation update | ||
| ## Checklist | ||
| - [ ] I have performed a self-review of my code | ||
| - [ ] I have commented my code where necessary | ||
| - [ ] I have updated the documentation if applicable | ||
| - [ ] My changes generate no new warnings | ||
| --- | ||
| ## We want to ensure high quality of the packages. Make sure that you've checked the boxes below before sending a pull request. | ||
| - [ ] I have read the [Contribution Guidelines](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#contribution-guidelines) | ||
| - [ ] I have read the [Maintainers Note](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#maintainers) | ||
| - [ ] I have read the [Quality Standards](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#quality-standards) | ||
| _Not every repository (project) will require every option, but most projects should. Check the Contribution Guidelines for details._ | ||
| - [ ] The repo documentation has a pkg.go.dev link. | ||
| - [ ] The repo documentation has a coverage service link. | ||
| - [ ] The repo documentation has a goreportcard link. | ||
| - [ ] The repo has a version-numbered release and a go.mod file. | ||
| - [ ] The repo has a continuous integration process that automatically runs tests that must pass before new pull requests are merged. | ||
| - [ ] Continuous integration is used to attempt to catch issues prior to releasing this package to end-users. | ||
| ## Please provide some links to your package to ease the review | ||
| - [ ] forge link (github.com, gitlab.com, etc): | ||
| - [ ] pkg.go.dev: | ||
| - [ ] goreportcard.com: | ||
| - [ ] coverage service link ([codecov](https://codecov.io/), [coveralls](https://coveralls.io/), etc.): | ||
| ## Pull Request content | ||
| - [ ] The package has been added to the list in alphabetical order. | ||
| - [ ] The package has an appropriate description with correct grammar. | ||
| - [ ] As far as I know, the package has not been listed here before. | ||
| ## Category quality | ||
| _Note that new categories can be added only when there are 3 packages or more._ | ||
| Packages added a long time ago might not meet the current guidelines anymore. It would be very helpful if you could check 3-5 packages above and below your submission to ensure that they also still meet the Quality Standards. | ||
| Please delete one of the following lines: | ||
| - [ ] The packages around my addition still meet the Quality Standards. | ||
| - [ ] I removed the following packages around my addition: (please give a short reason for each removal) | ||
|
|
||
| Thanks for your PR, you're awesome! :sunglasses: |
There was a problem hiding this comment.
Remove duplicated template content.
Lines 64–112 contain a duplicate copy of the template with embedded diff metadata ("2 changes: 1 addition & 1 deletion", "Copied!", "Original file line number", etc.). This appears to be accidental copy/paste of diff output into the template file itself. The template should end at line 63 with the closing message.
Delete lines 64–112 entirely. The resulting file should contain only the template structure (lines 1–63).
🧰 Tools
🪛 LanguageTool
[uncategorized] ~65-~65: The official name of this software platform is spelled with a capital “H”.
Context: ...: 2 changes: 1 addition & 1 deletion 2 .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMP...
(GITHUB)
[style] ~95-~95: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...tion is used to attempt to catch issues prior to releasing this package to end-users. ##...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~97-~97: The official name of this software platform is spelled with a capital “H”.
Context: ...ge to ease the review - [ ] forge link (github.com, gitlab.com, etc): - [ ] pkg.go.dev...
(GITHUB)
[style] ~97-~97: In American English, abbreviations like “etc.” require a period.
Context: ...[ ] forge link (github.com, gitlab.com, etc): - [ ] pkg.go.dev: - [ ] goreportcard....
(ETC_PERIOD)
[style] ~112-~112: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...ch removal) Thanks for your PR, you're awesome! 😎
(AWESOME)
🪛 markdownlint-cli2 (0.18.1)
67-67: Hard tabs
Column: 27
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 45
(MD010, no-hard-tabs)
68-68: Multiple headings with the same content
(MD024, no-duplicate-heading)
70-70: Multiple headings with the same content
(MD024, no-duplicate-heading)
72-72: Multiple headings with the same content
(MD024, no-duplicate-heading)
74-74: Multiple headings with the same content
(MD024, no-duplicate-heading)
79-79: Multiple headings with the same content
(MD024, no-duplicate-heading)
85-85: Multiple headings with the same content
(MD024, no-duplicate-heading)
96-96: Multiple headings with the same content
(MD024, no-duplicate-heading)
101-101: Multiple headings with the same content
(MD024, no-duplicate-heading)
105-105: Multiple headings with the same content
(MD024, no-duplicate-heading)
🤖 Prompt for AI Agents
.github/PULL_REQUEST_TEMPLATE.md lines 64-112: remove the accidental pasted diff
metadata and duplicated template content (the "2 changes: 1 addition & 1
deletion", "Copied!", "Original file line number", and the entire duplicated
template block) so the file ends after the intended template closing at line 63;
ensure only the original template content (lines 1–63) remains with no
extraneous diff text.
1 participant
📝 Description
This PR adds a Pull Request template at .github/pull_request_template.md to help contributors follow the required contribution and quality standards defined in the Contribution Guidelines
The template includes checklists for contributors to:
This improves the consistency of submitted PRs and simplifies the review process for maintainers.
Benefits
File Added
.github/pull_request_template.md
Fixes #5826
Summary by CodeRabbit