[Feature]: Add a Pull Request template #148
Description
Problem Statement
The repository currently has well-structured issue templates (bug report, feature request, description) but lacks a Pull Request template (.github/pull_request_template.md).
Without a PR template, contributors may submit pull requests with inconsistent descriptions, missing context, or no reference to related issues — making code reviews slower and less effective.
Proposed Solution
Add a .github/pull_request_template.md file that provides a consistent structure for all pull requests. The template should include sections for:
- Description — A summary of what the PR does and why.
- Related Issue — A link to the issue this PR addresses (e.g.,
Closes #123). - Type of Change — Checklist to classify the PR (bug fix, new feature, breaking change, documentation, etc.).
- Component(s) Affected — Which part of the project is impacted (
library/,prototype/,data/,analysis/,docs/). - How Has This Been Tested? — Description of how the changes were validated.
- Checklist — Pre-merge checklist (tests pass, lint clean, docs updated, etc.).
Benefits
- Ensures all PRs have consistent, reviewable descriptions.
- Encourages contributors to link related issues and describe their testing.
- Speeds up the code review process for maintainers.
- Aligns with the existing issue template standards already in place.
Additional Context
The project already uses GitHub Issue Forms (.github/ISSUE_TEMPLATE/) with structured YAML templates. Adding a PR template is the natural next step to standardize the full contribution workflow. This pairs well with the existing CONTRIBUTING.md guide.