Skip to content

Conversation

@TheGiraffe3
Copy link
Member

Description:

Adds a section to the pull request template about linking issues, as suggested in #2401

Please complete the following:

  • I have added screenshots for all UI updates
  • I process any text displayed to the user through translateText() and I've added it to the en.json file
  • I have added relevant tests to the test directory
  • I confirm I have thoroughly tested these changes and take full responsibility for any bugs introduced

Please put your Discord username so you can be contacted if a bug or regression is found:

loymdayddaud

@TheGiraffe3 TheGiraffe3 self-assigned this Nov 6, 2025
@TheGiraffe3 TheGiraffe3 requested a review from a team as a code owner November 6, 2025 07:20
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 6, 2025

Walkthrough

Updated the pull request template to include guidance for linking related issues. Added two instructional lines at the template top directing contributors to link an issue if applicable, or remove the lines if not applicable.

Changes

Cohort / File(s) Summary
PR Template Update
.github/PULL_REQUEST_TEMPLATE.md
Added two new lines at the top: instruction text directing users to link issues and a Resolves #(issue number) placeholder

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • evanpelle

Poem

📋✨ Templates grow with care and thought,
Now issues linked as they ought,
Two lines of wisdom, simple and clear,
Guide each contributor far and near! 🎯

Pre-merge checks

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Update pull request template' accurately describes the main change in the changeset, which adds instructions about linking issues to the PR template.
Description check ✅ Passed The description is related to the changeset, explaining that a section about linking issues was added to the PR template as suggested in issue #2401.

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.

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-2: LGTM! Clear guidance for contributors on linking issues.

The new lines improve the template by explicitly instructing contributors to link related issues. The simple, conversational tone is appropriate for a template.

One optional improvement: Consider using "resolves" instead of "fixes" on line 1 to align with the GitHub issue-linking convention shown on line 2. This creates consistency and reinforces the proper syntax.

-If this PR fixes an issue, link it below. If not, delete these two lines.
+If this PR resolves an issue, link it below. If not, delete these two lines.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5dde4cc and ac52ba7.

📒 Files selected for processing (1)
  • .github/PULL_REQUEST_TEMPLATE.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/PULL_REQUEST_TEMPLATE.md

[style] ~1-~1: Consider using a different verb for a more formal wording.
Context: If this PR fixes an issue, link it below. If not, delete...

(FIX_RESOLVE)

⏰ 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: Deploy to openfront.dev

Copy link
Collaborator

@evanpelle evanpelle left a comment

Choose a reason for hiding this comment

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

thanks!

@evanpelle evanpelle merged commit aa6d3eb into main Nov 7, 2025
12 of 13 checks passed
@evanpelle evanpelle deleted the pr-template-update branch November 7, 2025 23:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants