diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d987d22ec8a..6ada7f0a7b7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,21 +1,56 @@ +# Pull Request Template + +## ๐Ÿ“‹ Summary +- What problem does this PR solve? +- What changes were made? +- Why are these changes needed? -Here are some checklists you may like to use. Use your judgement. +## ๐Ÿ”— Related Issues + +- Related issue(s): -This is just a checklist, all the normative suggestions are covered in more detail in CONTRIBUTING. +## ๐Ÿ›  Implementation Details + +- Key changes: +- Dependencies added/removed: +- Design notes: + +## ๐Ÿงช Testing + +- Manual tests performed: +- Unit/integration tests added: +- Steps to reproduce (if applicable): + +## โš ๏ธ Breaking Changes + +- Breaking changes: +- Migration notes: + +## โœ… Checklist + +- [ ] Code builds without errors +- [ ] Tests pass +- [ ] Documentation updated +- [ ] Changelog updated (if applicable) +- [ ] Code is reviewed and self-reviewed +- [ ] Files formatted according to project style + +## ๐Ÿ“Ž Additional Notes + -Pre-submit checklist: -- Branch - - [ ] Tests are provided (if possible) - - [ ] Commit sequence broadly makes sense - - [ ] Key commits have useful messages - - [ ] Changelog fragments have been written (if appropriate) - - [ ] Relevant tickets are mentioned in commit messages - - [ ] Formatting, PNG optimization, etc. are updated -- PR - - [ ] (For external contributions) Corresponding issue exists and is linked in the description - - [ ] Targeting master unless this is a cherry-pick backport - - [ ] Self-reviewed the diff - - [ ] Useful pull request description - - [ ] Reviewer requested