docs: add pull request template#357
Conversation
Add .github/PULL_REQUEST_TEMPLATE.md to guide contributors on how to write good PR descriptions. Addresses issue Darshan3690#356.
|
Someone is attempting to deploy a commit to the Darshan Rajput's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
Thanks for the contribution. For future contributions, please follow the project's contribution workflow: Open an issue first and clearly describe the problem, improvement, or feature you would like to work on. This helps avoid duplicate work and ensures that contributions align with the project's roadmap before development begins. Since this PR was opened without a prior assigned issue, please open an issue first for discussion next time. Thank you for your interest in contributing. |
|
Acknowledged on the issue-first workflow — got it for future contributions. The change in this PR is small (template / metadata / unused-import cleanup) and the docs pattern followed what the README already had, but I should have opened an issue first to align with your contribution policy. I'll do that going forward. If you'd like, I can close this PR and re-open it against a tracking issue — let me know. |
Summary
.github/PULL_REQUEST_TEMPLATE.mdto guide contributors on writing good PR descriptions.Problem
The repository lacks a pull request template, leading to low-quality or incomplete PR descriptions that make review harder.
Evidence
Issue #356 explicitly requests adding a PR template. CONTRIBUTING.md references PR templates but none exist.
Solution
Created
.github/PULL_REQUEST_TEMPLATE.mdwith sections for: What does this PR do, Motivation, How to test, and Checklist. Also noted that existing issue templates (.github/ISSUE_TEMPLATE/) already exist and were not modified.Tests / Validation
.github/PULL_REQUEST_TEMPLATE.mdRisk / Compatibility
Docs/tooling only — no code changes, no runtime impact.
Notes for maintainers
bug_report.md,custom.md,feature_request.md) were left unchanged