diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..b075cc5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,83 @@ +# ๐Ÿ“Œ Summary + +Provide a brief description of the change and the reasoning behind it. + +--- + +# ๐Ÿ‘ฅ Reviewers + +## โœ… Required Reviewers +- @username1 +- @username2 + +## ๐Ÿงฉ Optional Reviewers +- @username3 +- @username4 + +(Feel free to add/remove as needed.) + +--- + +# ๐Ÿ” Related Issue(s) + +- Closes # +- Related to # + +--- + +# ๐Ÿ› ๏ธ What Changed? + +Describe the main changes in this PR: +- +- +- + +--- + +# ๐Ÿงช Testing + +Describe how you verified functionality: + +- [ ] Unit tests added +- [ ] Existing tests pass +- [ ] Manual testing performed + +**Steps to reproduce/test:** +1. +2. +3. + +--- + +# ๐Ÿ Python Code Quality Checklist + +Before requesting review, ensure: + +- [ ] I ran **`make format`** +- [ ] I ran **`make lint`** +- [ ] I ran **`make typecheck`** +- [ ] I ran **`make test`** +- [ ] All CI checks pass +- [ ] Code follows project style & conventions +- [ ] New functions/classes include docstrings +- [ ] Public APIs are typed (type hints) + +--- + +# ๐Ÿ“š Documentation + +- [ ] Code comments updated +- [ ] README updated (if needed) +- [ ] User-facing docs updated (if needed) + +--- + +# ๐Ÿ“ˆ Screenshots / Logs (optional) + +Attach outputs, plots, logs, or GIFs here. + +--- + +# ๐Ÿ™ Additional Notes + +Anything else reviewers should know?