diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..a6602ba --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,103 @@ +## ๐Ÿ“‹ Description + + + +## ๐Ÿ”„ Type of Change + + + +- [ ] ๐Ÿ› 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 update +- [ ] ๐Ÿ”ง Refactoring (no functional changes, no api changes) +- [ ] ๐Ÿงช Tests (adding missing tests or correcting existing tests) +- [ ] ๐ŸŽจ Style changes (formatting, missing semi colons, etc; no code changes) +- [ ] โšก Performance improvements +- [ ] ๐Ÿ”’ Security improvements + +## ๐Ÿงช Testing + + + +### Manual Testing +- [ ] Tested API endpoints manually +- [ ] Verified database operations work correctly +- [ ] Checked error handling scenarios +- [ ] Tested with different data inputs + +### Automated Testing +- [ ] All existing tests pass +- [ ] Added new tests for new functionality +- [ ] Updated tests for modified functionality + +## ๐Ÿ“Š Database Changes + + + +- [ ] No database changes +- [ ] New migration created +- [ ] Migration tested (upgrade/downgrade) +- [ ] Database schema updated + +## ๐Ÿ“š Documentation + + + +- [ ] README.md updated +- [ ] API documentation updated +- [ ] Code comments added/updated +- [ ] CONTRIBUTING.md updated (if needed) + +## โœ… Checklist + + + +### Code Quality +- [ ] Code follows the project's coding standards +- [ ] Self-review of code completed +- [ ] Code is properly formatted (`ruff format .`) +- [ ] Linting checks pass (`ruff check .`) +- [ ] No unused imports or variables +- [ ] Meaningful variable and function names used + +### Functionality +- [ ] Changes work as expected +- [ ] No breaking changes (or documented if unavoidable) +- [ ] Error handling implemented appropriately +- [ ] Input validation added where necessary +- [ ] Security considerations addressed + +### Performance +- [ ] No performance regressions introduced +- [ ] Database queries optimized (if applicable) +- [ ] Memory usage considered + +## ๐Ÿ”— Related Issues + + + +Closes #(issue_number) +Fixes #(issue_number) +Resolves #(issue_number) + +## ๐Ÿ“ธ Screenshots (if applicable) + + + +## ๐Ÿš€ Deployment Notes + + + +- [ ] No special deployment steps required +- [ ] Requires database migration (`alembic upgrade head`) +- [ ] Requires environment variable updates +- [ ] Other deployment notes (specify below) + +## ๐Ÿค” Questions/Concerns + + + +## ๐Ÿ“ Additional Notes + + \ No newline at end of file