diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..b8237aa --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,38 @@ +## What does this PR do? + +Explain here what you changed and why. Doesn't need to be long, just enough +for a reviewer to understand the change without reading every line of +diff. If it was a bug fix, briefly describe what was broken. Delete this paragraph and replace it with your description. + +## Closes + +List any issues that are linked to this pull request (e.g., `Closes #123`). + +- Closes # + +## Type of change(s) + +- [ ] Bug fix +- [ ] New feature +- [ ] Documentation update +- [ ] Style / UI change +- [ ] Refactor (no functional change) +- [ ] Performance improvement +- [ ] Other + +## Checklist + +- [ ] I've tested this change locally and it works as expected +- [ ] `bun run build` or `npm run build` completes without errors +- [ ] My commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) (e.g. `fix: ...`, `feat: ...`, `chore: ...`) +- [ ] I've updated relevant docs (README, comments, etc.) if this change needs it +- [ ] No leftover `console.log` or debug code + +## Screenshots / recordings (if applicable) + +If this changes anything visual, a before/after screenshot or a short clip makes review a lot faster. Delete this section if it doesn't apply. + +## Anything else the reviewer should know? + +Extra context, known limitations, or specific things you'd like a +second opinion on. Delete this section if there's nothing to add.