Problem
While contributing to this repository, I noticed there's no pull request template in .github. This means contributors don't have clear guidance on what information to include in their PRs, which can lead to inconsistent PR descriptions and require more back-and-forth during code review.
Proposed solution
Add a pull request template at .github/pull_request_template.md that guides contributors to provide essential information, similar to how the existing issue templates (bug_report.md, feature_request.md, doc_improvement.md) guide issue creation.
The template could include sections for:
- Description (what problem does this solve?)
- Changes made (high-level overview)
- Testing performed (quality checks, unit tests, manual testing)
- Related issues (Fixes #XXX, Relates to #XXX)
- Checklist (code quality, tests added, documentation updated)
Is this not possible with the current options
This cannot be achieved with current repository configuration - there is no PR template in place.
Alternatives considered
- Relying on PR descriptions without a template (current state) - but this leads to inconsistent and sometimes incomplete information
- Adding PR guidelines to CONTRIBUTING.md only - but a template provides better structure and is automatically shown to contributors
Additional context
Having consistent PR templates benefits both contributors and maintainers:
- Contributors know exactly what information to provide
- Maintainers can review PRs more efficiently with consistent structure
- Important details are less likely to be missed
- Aligns with the existing well-structured issue templates
Checklist
Problem
While contributing to this repository, I noticed there's no pull request template in
.github. This means contributors don't have clear guidance on what information to include in their PRs, which can lead to inconsistent PR descriptions and require more back-and-forth during code review.Proposed solution
Add a pull request template at
.github/pull_request_template.mdthat guides contributors to provide essential information, similar to how the existing issue templates (bug_report.md, feature_request.md, doc_improvement.md) guide issue creation.The template could include sections for:
Is this not possible with the current options
This cannot be achieved with current repository configuration - there is no PR template in place.
Alternatives considered
Additional context
Having consistent PR templates benefits both contributors and maintainers:
Checklist