Create pull request template #90
Conversation
There was a problem hiding this comment.
Pull request overview
This PR creates a pull request template to standardize PR descriptions in the repository. However, there are critical issues with the file location and content that need to be addressed.
- Adds a new PR template file to guide contributors in creating pull requests
- Includes placeholder sections for general description and two features
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| [General description] | ||
|
|
||
| ## Feature 1 | ||
|
|
||
| [Description of Feature 1] | ||
|
|
||
| ## Feature 2 | ||
|
|
||
| [Description of Feature 2] |
There was a problem hiding this comment.
The pull request template is located in the wrong directory path. GitHub expects pull request templates to be in .github/PULL_REQUEST_TEMPLATE.md (as a file) or .github/PULL_REQUEST_TEMPLATE/ (as a directory with template files), but the template files in the directory should NOT be named pull_request_template.md. When using the directory approach, template files should have descriptive names like feature_template.md or bugfix_template.md. The current path .github/PULL_REQUEST_TEMPLATE/pull_request_template.md is redundant and won't be automatically recognized by GitHub. Either rename this file to .github/pull_request_template.md or place it directly as .github/PULL_REQUEST_TEMPLATE.md for it to be used as the default template.
| [General description] | ||
|
|
||
| ## Feature 1 | ||
|
|
||
| [Description of Feature 1] | ||
|
|
||
| ## Feature 2 | ||
|
|
||
| [Description of Feature 2] |
There was a problem hiding this comment.
The template content is too generic and lacks useful guidance for contributors. Consider including sections that are commonly found in effective pull request templates such as: description of changes, type of change (bug fix, new feature, breaking change), testing performed, checklist items (e.g., code follows style guidelines, self-review completed, tests added), and related issue numbers. The current placeholder text like "[General description]" and generic "Feature 1/2" headings don't provide actionable guidance.
| [General description] | |
| ## Feature 1 | |
| [Description of Feature 1] | |
| ## Feature 2 | |
| [Description of Feature 2] | |
| ## Description | |
| Please provide a summary of the changes and the motivation behind them. | |
| ## Type of change | |
| - [ ] Bug fix | |
| - [ ] New feature | |
| - [ ] Breaking change | |
| - [ ] Documentation update | |
| - [ ] Other (please describe): | |
| ## How Has This Been Tested? | |
| Please describe the tests that you ran to verify your changes. Provide instructions so reviewers can reproduce. Please also list any relevant details for your test configuration. | |
| ## Checklist | |
| - [ ] My code follows the style guidelines of this project | |
| - [ ] I have performed a self-review of my own code | |
| - [ ] I have commented my code, particularly in hard-to-understand areas | |
| - [ ] I have made corresponding changes to the documentation | |
| - [ ] I have added tests that prove my fix is effective or that my feature works | |
| - [ ] New and existing unit tests pass locally with my changes | |
| - [ ] Any dependent changes have been merged and published in downstream modules | |
| ## Related Issues | |
| Please link to any related issues or pull requests here. |
Creates the pull request template.