Skip to content

Add comprehensive PR template with quality checklist #84

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
CreativeCodingSolutions wants to merge 1 commit into
base: master
Choose a base branch
from
+52 −0
Open

Add comprehensive PR template with quality checklist #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 36 additions & 0 deletions pr-quality/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Pull Request
about: Submit a pull request to improve this project
labels: needs review
---

## Description
<!-- Describe the change and why it's needed. Be specific. -->

## Related Issues
<!-- Link related issues: "Closes #123", "Fixes #456", "Related to #789" -->

## Type of Change
- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that breaks existing behavior)
- [ ] Documentation update
- [ ] Refactoring / dependency update
- [ ] CI / build configuration

## Testing
<!-- Describe how you tested this change. -->
- [ ] Tests added / updated
- [ ] Manual testing completed

## Checklist
- [ ] My PR has a descriptive title (not just "fix" or "update")
- [ ] My PR description is at least 50 characters
- [ ] I've linked to the relevant issue(s)
- [ ] My changes are scoped to a single logical change
- [ ] I've added or updated tests
- [ ] I've run linting and testing locally

---

> 💡 **Want to check PR quality before submitting?** Paste your PR URL into [PR Quality Analyzer](https://creativecodingsolutions.github.io/pr-quality-analyzer/) for a free A-F score with detailed breakdown.
16 changes: 16 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,22 @@

Find your issue/PR templates, and just grab and go.

| Template | Description |
|----------|-------------|
| [bugs-only](/bugs-only) | Bug-fix-only PRs with detailed reproduction steps |
| [checklist](/checklist) | General checklist-based issue and PR templates |
| [checklist2](/checklist2) | Alternative checklist-style templates |
| [conversational](/conversational) | Conversational issue template |
| [emoji-guide](/emoji-guide) | Emoji-labeled issue and PR templates |
| [must-open-issue-before-pr](/must-open-issue-before-pr) | Requires an issue before submitting a PR |
| [no-duplicates](/no-duplicates) | Duplicate issue prevention template |
| [pr-quality](/pr-quality) *New!* | PR template with quality checklist and PR Quality Analyzer integration |
| [questions-answers](/questions-answers) | Q&A style issue template |
| [screenshots](/screenshots) | Screenshot-focused issue template |
| [simple](/simple) | Minimal issue and PR templates |
| [squash-commits](/squash-commits) | Squash commit oriented PR template |
| [system](/system) | System information issue template |

*Inspired by excellent GitHub projects that use issue and pull request templates.*

Templates here are either copied from or modified based on real projects on GitHub.
Expand Down