diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..c29c281 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,43 @@ +## ๐ŸŽฏ Purpose + +*What problem does this PR solve or what feature does it add? Mention issues related to it* + +TO COMPLETE + +## โš™๏ธ Approach + +*Describe the core changes introduced by this PR.* + +TO COMPLETE + +[ ] Change ... +[ ] Add ... +[ ] Fix ... +[ ] ... + +## ๐Ÿงช How to Test + +*How to verify that this PR works as intended.* + +TO COMPLETE + +## ๐Ÿ”— Dependencies + +*Link PRs that must be merged before this one.* + +TO COMPLETE IF APPLICABLE + +## ๐Ÿ”œ Future Work + +*List any work intentionally left out of this PR, whether due to scope, prioritization, or pending decisions.* + +TO COMPLETE IF APPLICABLE + +## ๐Ÿ“‹ PR Completion Checklist + +*Mark only completed items. A complete PR should have all boxes ticked.* + +[ ] Complete PR description +[ ] Implement the core functionality +[ ] Add/update tests +[ ] Add/update documentation and inline comments