diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..d3d0ce8d --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,38 @@ +### Description +A clear and concise description of what the PR does. +- This PR does the following: + - Adds ... + - Fixes ... + - Updates ... + +### Related Issues +Link any related issues using the format `Fixes #issue_number`. +This helps to automatically close related issues when the PR is merged. +- Placeholder: "Fixes #123" + +### Changes +List the detailed changes made in this PR. +- Added a new feature to ... +- Refactored the ... +- Fixed a bug in ... + +### Testing Instructions +Detailed instructions on how to test the changes. Include any setup needed and specific test cases. +1. Pull this branch. +2. Run `npm install` to install dependencies. +3. Run `npm test` to execute the test suite. +4. Verify that ... + +### Screenshots (if applicable) +Add any screenshots that help explain or visualize the changes. + +### Additional Context +Any additional context or information that reviewers should be aware of. +- This PR is based on the following... + +### Checklist +Make sure to check off all the items before submitting. Mark with [x] if done. +- [ ] I have performed a self-review of my code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] My changes generate no new warnings +- [ ] I am working on this issue under GSSOC