PR Quality Kit
Copy-paste templates, badges, and configs to enforce PR quality standards in your open-source repo. Free, zero setup.
Pull Request Template
Copy this .github/PULL_REQUEST_TEMPLATE.md into your repo. It enforces description quality, issue linking, and includes a badge link to the PR Quality Analyzer.
.github/PULL_REQUEST_TEMPLATE.md
---
name: Pull Request
about: Submit a pull request to improve this project
labels: needs review
---
## Description
## Related Issues
## 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
- [ ] 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 tests locally
---
[](https://creativecodingsolutions.github.io/pr-quality-analyzer/?pr=REPLACE_WITH_PR_URL)
Pro tip: Enable "Require pull request descriptions" in your repo settings (Settings → General → Pull Requests) to make the template mandatory. Pair with our PR Quality Gate GitHub Action for automated enforcement.
CONTRIBUTING.md Section
Add this section to your CONTRIBUTING.md to communicate PR quality expectations to contributors.
CONTRIBUTING.md — PR Quality Standards section
## Pull Request Quality Standards
We care about code review quality. Before submitting a PR:
1. **Write a descriptive title** — explain what the change does, not just "fix" or "update"
2. **Fill out the PR description** — at least 50 characters explaining the what and why
3. **Link to related issues** — use "Closes #123" or "Fixes #456" to auto-close issues on merge
4. **Keep PRs focused** — one logical change per PR. Large PRs take longer to review
5. **Add labels** — categorize your PR (bug, feature, docs, etc.)
Quick check: paste your PR URL into the PR Quality Analyzer to get an instant quality score before requesting review.GitHub Action Configuration
Add PR Quality Gate to your CI pipeline. It checks description length, labels, and linked issues on every PR. Copy this into .github/workflows/pr-quality.yml.
.github/workflows/pr-quality.yml
name: PR Quality Gate
on:
pull_request:
types: [opened, edited, synchronize, reopened]
permissions:
contents: read
pull-requests: write
issues: read
jobs:
quality:
runs-on: ubuntu-latest
steps:
- uses: CreativeCodingSolutions/pr-quality-gate@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
min-description-length: "50"
require-labels: "true"
require-linked-issue: "false"
mode: warn
comment-on-pr: true
custom-message: "Thanks for contributing! Please review the quality checks above."
Tip: Start in
warn mode so it doesn't block contributions. Switch to fail mode once your team is used to the standards. See full docs →
README Badge
Show visitors that your repo cares about PR quality. Add this badge to your README.md.
Badge Markdown
[](https://github.com/CreativeCodingSolutions/pr-quality-gate)
[-58a6ff)](https://creativecodingsolutions.github.io/pr-quality-analyzer/)
Live badge: When you analyze a specific PR on the PR Quality Analyzer, it generates a custom badge with that PR's score. Use that to show off your team's PR quality.
Quick Setup Checklist
- Add
.github/PULL_REQUEST_TEMPLATE.mdto your repo - Add the CONTRIBUTING.md section above
- Add PR Quality Gate as a GitHub Action workflow
- Add a README badge showing you care about PR quality
- Enable "Require pull request descriptions" in repo settings
- Encourage contributors to run the PR Quality Analyzer before submitting