diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index ed995d7c..62991ece 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -1,32 +1,162 @@ -# Description +# ๐Ÿ“‹ Pull Request -Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. +## ๐Ÿ“ Description -Fixes # (issue) +**Summary:** Provide a clear and concise description of what this PR does. -## Type of change +**Context:** Explain the motivation behind these changes and any relevant background information. -Please delete options that are not relevant. +**Related Issues:** +- Closes #(issue) +- Addresses #(issue) +- Related to #(issue) -- [ ] Bug fix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] This change requires a documentation update +--- -# How Has This Been Tested? +## ๐Ÿ”„ Type of Change -Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + -- [ ] Test A -- [ ] Test B +- [ ] ๐Ÿ› **Bug fix** - non-breaking change which fixes an issue +- [ ] โœจ **New feature** - non-breaking change which adds functionality +- [ ] ๐Ÿ’ฅ **Breaking change** - fix or feature that would cause existing functionality to not work as expected +- [ ] ๐Ÿ“š **Documentation** - updates to documentation only +- [ ] ๐ŸŽจ **Style** - formatting, missing semi colons, etc; no code change +- [ ] โ™ป๏ธ **Refactor** - code change that neither fixes a bug nor adds a feature +- [ ] โšก **Performance** - code change that improves performance +- [ ] โœ… **Test** - adding missing tests or correcting existing tests +- [ ] ๐Ÿ”ง **Build** - changes that affect the build system or external dependencies +- [ ] ๐Ÿ‘ท **CI** - changes to CI configuration files and scripts +- [ ] ๐Ÿš€ **Deploy** - changes related to deployment -# Checklist: +--- -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my code -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings -- [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing unit tests pass locally with my changes -- [ ] Any dependent changes have been merged and published in downstream modules +## ๐Ÿงช Testing + +### Test Coverage +- [ ] Unit tests added/updated +- [ ] Integration tests added/updated +- [ ] E2E tests added/updated +- [ ] Manual testing completed + +### Test Instructions + + +1. **Setup:** + ```bash + npm install + npm run build + ``` + +2. **Test scenarios:** + - [ ] Scenario A: _describe test case_ + - [ ] Scenario B: _describe test case_ + - [ ] Edge cases: _describe edge cases tested_ + +3. **Verification:** + ```bash + npm run test + npm run lint + npm run type-check + ``` + +### Test Results + + +--- + +## ๐Ÿ“ธ Screenshots/Demo + + + +| Before | After | +|--------|-------| +| _screenshot/description_ | _screenshot/description_ | + +--- + +## ๐Ÿ“š Documentation + +- [ ] Code is self-documenting with clear variable/function names +- [ ] Added/updated JSDoc comments for public APIs +- [ ] Updated README.md if needed +- [ ] Updated CHANGELOG.md +- [ ] Added/updated component documentation +- [ ] Updated TypeScript type definitions + +--- + +## ๐Ÿ” Code Quality Checklist + +### Code Standards +- [ ] Code follows project's style guidelines (ESLint/Prettier) +- [ ] Code follows TypeScript best practices +- [ ] No `console.log` statements in production code +- [ ] No TODO/FIXME comments without corresponding issues +- [ ] Proper error handling implemented +- [ ] Security considerations addressed + +### Performance & Accessibility +- [ ] Performance impact considered and optimized +- [ ] Accessibility guidelines followed (WCAG 2.1) +- [ ] Mobile responsiveness tested +- [ ] Browser compatibility verified + +### Review & Testing +- [ ] Self-review completed +- [ ] Code is well-commented and self-explanatory +- [ ] All existing tests pass +- [ ] New tests added for new functionality +- [ ] Manual testing completed +- [ ] No new warnings or errors introduced + +--- + +## ๐Ÿš€ Deployment Considerations + +- [ ] No database migrations required +- [ ] No environment variable changes required +- [ ] Backward compatible with previous version +- [ ] Safe to deploy to production +- [ ] Feature flags implemented if needed + +--- + +## ๐Ÿ“ฆ Dependencies + + + +### Added +- `package-name@version` - _reason for addition_ + +### Updated +- `package-name@old-version` โ†’ `package-name@new-version` - _reason for update_ + +### Removed +- `package-name@version` - _reason for removal_ + +--- + +## ๐Ÿ”— Additional Information + +### Related PRs + + +### Breaking Changes + + +### Notes for Reviewers + + +--- + +## ๐Ÿ“‹ Reviewer Checklist + + + +- [ ] Code review completed +- [ ] Tests reviewed and adequate +- [ ] Documentation reviewed +- [ ] Breaking changes identified and documented +- [ ] Security implications considered +- [ ] Performance impact assessed