Skip to content

Add Pull Request (PR) template (#5826) #5906

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Add Pull Request (PR) template (#5826) #5906

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2f3eb3a
Add Pull Request (PR) template (#5826)
N-Yashwitha Oct 27, 2025
676fd8a
Rename PR template file to match repository convention
N-Yashwitha Oct 27, 2025
bfb3ded
Add official content to PULL_REQUEST_TEMPLATE.md
N-Yashwitha Oct 27, 2025
2272186
Add official PR template content to fix quality check
N-Yashwitha Oct 27, 2025
6a943d4
Add official PR template content to fix quality check
N-Yashwitha Oct 27, 2025
cd5316f
Move PR template into .github/PULL_REQUEST_TEMPLATE/ to align with re…
N-Yashwitha Oct 27, 2025
987a53f
Fix emoji lint issue in PR template
N-Yashwitha Oct 28, 2025
f307b23
Fix emoji lint issue in PR template
N-Yashwitha Oct 28, 2025
87defa5
Move PR template back to correct path
N-Yashwitha Oct 28, 2025
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
72 changes: 72 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
## Description of changes
Please describe the changes made in this Pull Request and why they are necessary.

## Related issues
Fixes #5826
Comment on lines +1 to +5
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 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:

  1. GitHub Docs — Creating a pull request template for your repository. [1]
  2. 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.


## 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)
Expand Down Expand Up @@ -38,3 +61,52 @@ Please delete one of the following lines:
- [ ] I removed the following packages around my addition: (please give a short reason for each removal)

Thanks for your PR, you're awesome! :sunglasses:
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:
Comment on lines +64 to +112
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

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.

Loading