diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 651810028e..7ee414958c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,12 +1,31 @@ -- [ ] This change is worth documenting at https://docs.all-hands.dev/ -- [ ] Include this change in the Release Notes. If checked, you **must** provide an **end-user friendly** description for your change below +## Summary of PR -**End-user friendly description of the problem this fixes or functionality this introduces.** + +## Change Type ---- -**Summarize what the PR does, explaining any non-trivial design decisions.** + +- [ ] Bug fix +- [ ] New feature +- [ ] Breaking change +- [ ] Refactor +- [ ] Other (dependency update, docs, typo fixes, etc.) ---- -**Link of any specific issues this addresses:** +## Checklist + +- [ ] I have read and reviewed the code and I understand what the code is doing. +- [ ] I have tested the code to the best of my ability and ensured it works as expected. + +## Fixes + + + +Resolves #(issue) + +## Release Notes + + + +- [ ] Include this change in the Release Notes.