Skip to content

Conversation

@N-Yashwitha
Copy link

@N-Yashwitha N-Yashwitha commented Oct 27, 2025

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.

This template improves the consistency of submitted PRs and simplifies the review process for maintainers.


Required Links

Placeholder links for validation purposes.


Benefits

  • Maintains high-quality and standardized PR submissions.
  • Saves maintainers time by ensuring contributors self-verify before submitting.
  • Improves contributor experience by providing a clear checklist.

File Added

.github/pull_request_template.md

Fixes #5826

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 27, 2025

Walkthrough

Replaces and restructures the repository's PR template at .github/PULL_REQUEST_TEMPLATE.md, converting the previous header and checkbox groups into clearly labeled sections (e.g., Description, Links, Checklist, Notes). No code or tooling changes.

Changes

Cohort / File(s) Summary
Pull Request Template
/.github/PULL_REQUEST_TEMPLATE.md
Rewrote template content: removed the original top-level guidance and "Category quality" block, replaced inline checkbox groups with labeled sections such as ### Description, ### Links (Required for new entries), ### Checklist, and ### Notes. Formatting and section organization updated; no functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Focus review on wording, section presence, and formatting of /.github/PULL_REQUEST_TEMPLATE.md.

Poem

🐇 I nudged a template neat and bright,
Sections hopping into place tonight,
Checklists tidy, links in line,
Reviewers smile — the fields align,
A little hop to guide each bite. 🥕

Pre-merge checks and finishing touches

✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The PR title clearly and specifically describes the main change: adding a Pull Request template file to the repository.
Linked Issues check ✅ Passed The PR implements all required objectives from #5826: adds .github/pull_request_template.md with Description, Links, Checklist, and Notes sections covering all specified fields.
Out of Scope Changes check ✅ Passed The PR only modifies the PR template file, which is directly aligned with the stated objective of adding a PR template; no out-of-scope changes detected.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link

github-actions bot commented Oct 27, 2025

Automated Quality Checks (from CONTRIBUTING minimum standards)

  • Repo: FAIL (missing go.mod)
  • pkg.go.dev: FAIL (unreachable)
  • goreportcard: OK (grade unknown)
  • coverage: FAIL (unreachable)

These checks are a best-effort automation and do not replace human review.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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:

  1. Check a box (standard checkbox behavior), or
  2. 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

📥 Commits

Reviewing files that changed from the base of the PR and between 6a943d4 and cd5316f.

📒 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.

@N-Yashwitha
Copy link
Author

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.
Please review or merge when convenient — all content and structure are valid. ✅

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cd5316f and 987a53f.

📒 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.

Comment on lines 1 to 5
## Description of changes
Please describe the changes made in this Pull Request and why they are necessary.

## Related issues
Fixes #5826
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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 987a53f and f307b23.

📒 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_TEMPLATE directory form (for multiple templates) and the lowercase pull_request_template.md single-file form are accepted and will be auto-detected. The current file path .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md follows 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between f307b23 and 87defa5.

📒 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.md is 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)

1-1: Fix Markdown heading formatting.

Lines 1, 6, 12, 21, and 26 have two spaces after the hash instead of one, which violates the MD019 rule. Change ### to ### (single space) for consistency.

Apply this diff to fix the heading formatting:

-###  Description of Changes
+### Description of Changes

Repeat for lines 6, 12, 21, and 26 (all headings).

Also applies to: 6-6, 12-12, 21-21, 26-26

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 87defa5 and 64ebc8d.

📒 Files selected for processing (1)
  • .github/PULL_REQUEST_TEMPLATE.md (1 hunks)
🧰 Additional context used
🧠 Learnings (5)
📓 Common learnings
Learnt from: elymanuba
Repo: avelino/awesome-go PR: 5762
File: README.md:0-0
Timestamp: 2025-08-14T23:46:18.545Z
Learning: When reviewing contributions to the awesome-go repository, maintain a relaxed and less pedantic approach. Users may find overly strict feedback about formatting, alphabetical ordering, or description tone to be unnecessary. Focus on major issues rather than minor stylistic preferences.
📚 Learning: 2025-10-08T00:38:13.132Z
Learnt from: CR
Repo: avelino/awesome-go PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-08T00:38:13.132Z
Learning: Applies to README.md : Do not remove existing list content unless removal is requested and justified

Applied to files:

  • .github/PULL_REQUEST_TEMPLATE.md
📚 Learning: 2025-08-14T23:46:18.545Z
Learnt from: elymanuba
Repo: avelino/awesome-go PR: 5762
File: README.md:0-0
Timestamp: 2025-08-14T23:46:18.545Z
Learning: When reviewing contributions to the awesome-go repository, maintain a relaxed and less pedantic approach. Users may find overly strict feedback about formatting, alphabetical ordering, or description tone to be unnecessary. Focus on major issues rather than minor stylistic preferences.

Applied to files:

  • .github/PULL_REQUEST_TEMPLATE.md
📚 Learning: 2025-10-08T00:38:13.132Z
Learnt from: CR
Repo: avelino/awesome-go PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-08T00:38:13.132Z
Learning: Applies to {README.md,COVERAGE.md} : Align rendered documentation (README.md, COVERAGE.md, etc.) with behavior changes in main.go or helper packages

Applied to files:

  • .github/PULL_REQUEST_TEMPLATE.md
📚 Learning: 2025-10-08T00:38:13.132Z
Learnt from: CR
Repo: avelino/awesome-go PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-08T00:38:13.132Z
Learning: Applies to **/*.go : Maintain ≥80% coverage for non-data packages and ≥90% for data packages when adding new testable Go code

Applied to files:

  • .github/PULL_REQUEST_TEMPLATE.md
🪛 markdownlint-cli2 (0.18.1)
.github/PULL_REQUEST_TEMPLATE.md

1-1: Multiple spaces after hash on atx style heading

(MD019, no-multiple-space-atx)


6-6: Multiple spaces after hash on atx style heading

(MD019, no-multiple-space-atx)


12-12: Multiple spaces after hash on atx style heading

(MD019, no-multiple-space-atx)


21-21: Multiple spaces after hash on atx style heading

(MD019, no-multiple-space-atx)


26-26: Multiple spaces after hash on atx style heading

(MD019, no-multiple-space-atx)

⏰ 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 (2)
.github/PULL_REQUEST_TEMPLATE.md (2)

1-33: Duplicate content has been successfully removed.

The file now contains exactly 33 lines and ends cleanly with the final checklist item. All duplicate content and extraneous diff metadata that was previously flagged (lines 64–112) have been removed. The PR template is properly formatted with no remaining issues.


1-33: File path is correct and will be auto-detected by GitHub.

GitHub's PR template auto-detection works with filenames that are not case-sensitive in locations including the .github/ directory. The file at .github/PULL_REQUEST_TEMPLATE.md meets GitHub's naming conventions and will be automatically detected.

No changes to the file path are required.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)

1-1: Minor: Remove extra space after heading hashes.

The section headings have two spaces after ### (e.g., ### Description). For consistency with markdown linting standards, use a single space: ### Description.

This is a low-priority formatting nit.

-###  Description
+### Description

Also applies to: 6-6, 15-15, 24-24

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 64ebc8d and 222a885.

📒 Files selected for processing (1)
  • .github/PULL_REQUEST_TEMPLATE.md (1 hunks)
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings
Learnt from: elymanuba
Repo: avelino/awesome-go PR: 5762
File: README.md:0-0
Timestamp: 2025-08-14T23:46:18.545Z
Learning: When reviewing contributions to the awesome-go repository, maintain a relaxed and less pedantic approach. Users may find overly strict feedback about formatting, alphabetical ordering, or description tone to be unnecessary. Focus on major issues rather than minor stylistic preferences.
📚 Learning: 2025-08-14T23:46:18.545Z
Learnt from: elymanuba
Repo: avelino/awesome-go PR: 5762
File: README.md:0-0
Timestamp: 2025-08-14T23:46:18.545Z
Learning: When reviewing contributions to the awesome-go repository, maintain a relaxed and less pedantic approach. Users may find overly strict feedback about formatting, alphabetical ordering, or description tone to be unnecessary. Focus on major issues rather than minor stylistic preferences.

Applied to files:

  • .github/PULL_REQUEST_TEMPLATE.md
📚 Learning: 2025-10-08T00:38:13.132Z
Learnt from: CR
Repo: avelino/awesome-go PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-08T00:38:13.132Z
Learning: Applies to {README.md,COVERAGE.md} : Align rendered documentation (README.md, COVERAGE.md, etc.) with behavior changes in main.go or helper packages

Applied to files:

  • .github/PULL_REQUEST_TEMPLATE.md
📚 Learning: 2025-10-08T00:38:13.132Z
Learnt from: CR
Repo: avelino/awesome-go PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-08T00:38:13.132Z
Learning: Applies to README.md : When modifying the Awesome list, keep categories with at least three entries

Applied to files:

  • .github/PULL_REQUEST_TEMPLATE.md
📚 Learning: 2025-10-08T00:38:13.132Z
Learnt from: CR
Repo: avelino/awesome-go PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-08T00:38:13.132Z
Learning: Applies to **/*.go : Maintain ≥80% coverage for non-data packages and ≥90% for data packages when adding new testable Go code

Applied to files:

  • .github/PULL_REQUEST_TEMPLATE.md
📚 Learning: 2025-10-08T00:38:13.132Z
Learnt from: CR
Repo: avelino/awesome-go PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-08T00:38:13.132Z
Learning: Applies to README.md : Avoid promotional copy; keep descriptions concise and neutral in the Awesome list

Applied to files:

  • .github/PULL_REQUEST_TEMPLATE.md
🪛 LanguageTool
.github/PULL_REQUEST_TEMPLATE.md

[style] ~25-~25: Consider using a different verb for a more formal wording.
Context: ...BUTING.md) --- ### Notes (If your PR fixes a specific issue, mention it here: `Fix...

(FIX_RESOLVE)

🪛 markdownlint-cli2 (0.18.1)
.github/PULL_REQUEST_TEMPLATE.md

1-1: Multiple spaces after hash on atx style heading

(MD019, no-multiple-space-atx)


6-6: Multiple spaces after hash on atx style heading

(MD019, no-multiple-space-atx)


15-15: Multiple spaces after hash on atx style heading

(MD019, no-multiple-space-atx)


24-24: Multiple spaces after hash on atx style heading

(MD019, no-multiple-space-atx)

⏰ 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 (2)
.github/PULL_REQUEST_TEMPLATE.md (2)

1-26: Template structure and content look good.

The PR template is well-organized with clear sections (Description, Links, Checklist, Notes) and provides helpful guidance for contributors. The checklist items align with awesome-go's quality standards, and the links section appropriately highlights required fields for new entries.


1-26: ****

The original review's concern about file naming is based on incorrect information. GitHub pull request template filenames are not case sensitive, so .github/PULL_REQUEST_TEMPLATE.md is valid and GitHub will correctly auto-detect and use this template. Additionally, the duplicated content issue mentioned in the past review has already been resolved—the file now contains only 26 lines with a clean, well-structured template. No changes are needed.

Likely an incorrect or invalid review comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Pull Request (PR) Template

2 participants