diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..bdbe5864 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,46 @@ +## What does this PR do? + + + +- Fixes #XXXX (GitHub issue number) + +## Visual Demo + +A visual demonstration is strongly recommended, for both the original and new change **(video / image)**. + +#### Video Demo (if applicable): + +- Show screen recordings of the issue or feature. +- Demonstrate how to reproduce the issue, the behavior before and after the change. + +#### Image Demo (if applicable): + +- Add side-by-side screenshots of the original and updated change. +- Highlight any significant change(s). + +## AI Assistance (Required) + +We allow AI-assisted development, but reviewers need transparency to assess risk, maintainability, and correctness. + +#### AI usage level (check one) + +- [ ] None (no AI used) +- [ ] Light (spellcheck/rewording/comments/docs only) +- [ ] Medium (AI suggested small code changes/snippets that I adapted) +- [ ] Heavy (AI significantly shaped the implementation or architecture) + +#### Which tool(s) where used? + +- e.g., ChatGPT, Copilot, Cursor, etc. + +## What was verified by the author? + + + +- [ ] I reviewed **and** understood all AI/human generated code +- [ ] I validated behavior locally (tests/manual verification) +- [ ] I checked edge cases and failure modes + +## Submission Acknowledgement + +- [ ] I acknowledge that a decent size PR without self-review might be rejected