diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6bdaa99..754a503 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,27 @@ -*Issue #, if available:* +## â„šī¸ Description +*Provide a concise summary of the changes introduced in this pull request.* -*Description of changes:* +- Link to the related issue(s): Issue # +- Describe the motivation and context for this change. +## 📋 Changes Summary + +Bullet-point key changes introduced. +Mention any dependencies, configuration changes, or additional requirements introduced. + +### âš™ī¸ Type of Change +Select the type(s) of change(s) included in this pull request: +- [ ] 🐞 Bug fix (non-breaking change which fixes an issue) +- [ ] ✨ New feature (adds new functionality without breaking existing usage) +- [ ] đŸ’Ĩ Breaking change (changes that might break existing user setups, scripts, or configurations) + + +## ✅ Checklist +Before requesting a review, confirm the following: +- [ ] I have reviewed my changes to ensure they meet the project's standards. +- [ ] I have tested my changes and ensured that all tests pass (`pdm run test`). +- [ ] I have verified that linting passes (`pdm run lint`). +- [ ] I have run security scans and addressed any identified issues (`pdm run audit`). +- [ ] I have updated documentation where necessary. By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.