Skip to content

chore(PR templates): fix PR templates - old ones were too busy - #235

Merged
Ryan-Millard merged 1 commit into
mainfrom
fix/PR-templates
Jan 19, 2026
Merged

chore(PR templates): fix PR templates - old ones were too busy#235
Ryan-Millard merged 1 commit into
mainfrom
fix/PR-templates

Conversation

@Ryan-Millard

@Ryan-Millard Ryan-Millard commented Jan 19, 2026

Copy link
Copy Markdown
Owner

Below is the exact change I made - 1 PR template for everything to simplify it all.


What was changed & why

Fixes:

Changes

Testing & Verification

Additional Resources

Summary by CodeRabbit

  • Chores
    • Simplified and consolidated pull request templates into a unified structure for improved consistency in the contribution process.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai

coderabbitai Bot commented Jan 19, 2026

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

The PR consolidates multiple specialized GitHub pull request templates into a single standardized template. Four template variant files (bugfix, chore, docs, feature) are removed, while the main template is restructured with new sections for documenting what was changed and why, fixes, changes, testing verification, and additional resources.

Changes

Cohort / File(s) Summary
Main PR Template Redesign
.github/PULL_REQUEST_TEMPLATE.md
Replaced template structure; removed original header and template links; added preface comment, "What was changed & why" section, and reorganized blocks for Fixes, Changes, Testing & Verification, and Additional Resources. (+20/-48)
Deprecated Variant Templates
.github/PULL_REQUEST_TEMPLATE/bugfix.md, .github/PULL_REQUEST_TEMPLATE/chore.md, .github/PULL_REQUEST_TEMPLATE/docs.md, .github/PULL_REQUEST_TEMPLATE/feature.md
Deleted all four specialized PR template variant files; removed structured sections and guidance for bug fixes, maintenance, documentation, and feature PRs respectively.

Poem

🐰 One template to rule them all, no more—
Bugfix, chore, docs, feature, four doors now one.
A unified form, streamlined and bright,
Where all contributions find their way right. ✨

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: consolidating multiple busy PR templates into a single simplified template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

@Ryan-Millard

Copy link
Copy Markdown
Owner Author
<!--
Thanks for contributing to Img2Num!

Please note that by submitting this pull request to **Img2Num**, you confirm that:  
1. You have read and agree to the contribution guidelines.
2. Your submission complies with our licensing, including attribution and redistribution rules.  
3. All code, documentation, and other contributions are your original work or you have permission to submit them.  
4. You understand that your contributions may be reviewed and edited for consistency and quality before merging.
 -->

## What was changed & why
<!-- A sentence or two describing the change. -->
<!-- A brief motivation for this change -->




<!-- Use the fixes keyword below and the issue related to this PR to link them. -->
Fixes: 

## Changes
<!-- A list of important changes -->




## Testing & Verification
<!-- If there are tests, explain how you wrote them. Otherwise, explain how you know this works.  -->
<!-- This doesn't apply to docs -->




## Additional Resources
<!-- Extra information, e.g. screenshots -->

@Krasner, is this better?

@Krasner

Krasner commented Jan 19, 2026

Copy link
Copy Markdown
Collaborator

Yes much better. The old one has a too much text and seemed like a bunch of LLM generated sections.

@Ryan-Millard
Ryan-Millard merged commit 0595fcf into main Jan 19, 2026
7 checks passed
@Ryan-Millard
Ryan-Millard deleted the fix/PR-templates branch January 19, 2026 14:33
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.

2 participants