diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b4ef17373..0aa70c0a1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -# PR Type +# 🔘 PR Type What kind of change does this PR introduce? @@ -6,17 +6,35 @@ What kind of change does this PR introduce? - [ ] Bugfix - [ ] Enhancement - [ ] Code style update (formatting, local variables) -- [ ] Refactoring (no functional changes, no api changes) +- [ ] Refactoring (no functional changes, no API changes) - [ ] Build related changes - [ ] CI related changes - [ ] Documentation content changes - [ ] Other... Please describe: +# 📜 Background +Provide a brief explanation of why this pull request is needed. Include the problem you are solving or the functionality you are adding. Reference any related issues. -# What is the current behavior? -(Optional) Resolved: #`Insert issue number` +Issue Link: #[issue_number] +Context Link (if applicable): +# 🔄 Changes +Enumerate the changes made in this pull request, detailing what has been modified, added, or removed. Include technical details and implications if necessary. -# What is the new behavior? +Impact: +- Explain the broader impact of these changes. +- How it improves performance, fixes bugs, adds functionality, etc. -# Screenshot / Video \ No newline at end of file +# 🖼 Screenshot / 📹 Video +Include screenshots or a video demonstrating the changes. This is especially helpful for UI changes. + +# ✅ Review checklist +Please ensure the following are true before merging: + +- [ ] Code Style is consistent with the project guidelines. +- [ ] Code is readable and well-commented. +- [ ] No unnecessary or debugging code has been added. +- [ ] Security considerations have been taken into account. +- [ ] The change has been manually tested and works as expected. +- [ ] Breaking changes and their impacts have been considered and documented. +- [ ] Code does not introduce new technical debt or issues.