Skip to content

ENH: Add pull request template to .github #1853

@colesmcintosh

Description

@colesmcintosh

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

  • I have searched the existing issues and have not found a similar feature request.
  • I have verified that this feature is not already implemented in the latest version.
  • I am willing to work on this feature and submit a pull request.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions