Files
kfmtbox/.github/pull_request_template.md
2025-09-01 17:02:48 -05:00

2.6 KiB

📋 Pull Request Description

  • Closes #(issue number)
  • Related to #(issue number)

🎯 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
  • 🧪 Test improvements
  • 🔧 Refactoring (no functional changes)
  • ⚡ Performance improvement
  • 🔒 Security fix

🧪 Testing

  • Unit tests pass
  • Integration tests pass
  • Manual testing completed
  • Tested on multiple platforms (if applicable)

Test Commands

# Add any specific test commands you ran
cargo test
cargo clippy
cargo fmt

📸 Screenshots/Examples

Before

# Example of behavior before changes

After

# Example of behavior after changes

🔍 Code Quality

  • Code follows project style guidelines
  • Self-review completed
  • Code is properly commented
  • No unnecessary debug code or comments
  • Error handling is appropriate
  • Performance implications considered

📚 Documentation

  • README updated (if needed)
  • Code comments added/updated
  • API documentation updated (if applicable)
  • Examples updated (if applicable)

🚀 Deployment Notes

  • No breaking changes
  • Backward compatibility maintained
  • Migration guide needed (if breaking changes)
  • Configuration changes documented

✅ Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own 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

🔄 Additional Notes

👥 Reviewers

@username