pull_request_template.md

Description

Related Issue

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)
• ⚡ Performance improvement
• ✅ Test addition/update
• 🔧 Configuration change
• 🎨 Style/formatting changes
• 🧹 Chore/maintenance

Target Branch

• develop (for features, bug fixes, chores, dependency updates from Dependabot)
• main (for hotfixes only)

Changes Made

Testing

• All existing tests pass
• New tests added (if applicable)
• Manual testing completed (if applicable)

Test commands:

# Add test commands here
pytest

Checklist

Code Quality

• Code follows project style guidelines (code-style.md)
• Code follows Django best practices
• Type hints added where appropriate
• No debug statements or commented-out code
• One class per file (if applicable)
• Field name constants used (if applicable)

Tests

• All tests pass: pytest
• New features have corresponding tests
• Bug fixes include regression tests
• Tests follow naming convention: test_{scenario}_then_{expected_result}
• Each test focuses on a single scenario

Documentation

• Docstrings updated (only when needed)
• README updated (if applicable)
• CHANGELOG.md updated in [Unreleased] section
• Type hints added/updated

Git Hygiene

• Commit messages follow convention: <type>(<scope>): <summary>
• Branch is up to date with target branch
• Branch follows naming convention (feature/, chore/, dependabot/, hotfix/, release/)
• No accidental commits (large files, secrets, personal configs)

Breaking Changes

• This PR includes breaking changes
• Breaking changes are documented in the description above
• Migration path provided (if applicable)

Breaking Changes:

Screenshots (if applicable)

Additional Notes

Reviewer Notes