Skip to content

PULL_REQUEST_TEMPLATE.md

Latest commit

 

History

History
118 lines (90 loc) · 2.94 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

118 lines (90 loc) · 2.94 KB
Raw

Pull Request

📋 Summary

Brief description of what this PR does and why it's needed.

🎯 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)
  • 🔒 Security improvement
  • ⚡ Performance improvement
  • 🎨 Style/UI changes

🔄 Changes Made

Added

Changed

Fixed

Removed

🧪 Testing

  • Unit tests pass (npm test)
  • Integration tests pass
  • Manual testing completed
  • VS Code extension tested (if applicable)
  • Cross-platform testing (Windows/macOS/Linux)

Test Cases

  1. Scenario:
    • Steps:
    • Expected:
    • Result: ✅/❌

📱 Environment Tested

  • OS: Windows / macOS / Linux
  • Node.js: v18 / v20 / v21
  • VS Code: Latest version (if extension changes)

🔗 Related Issues

  • Closes #___
  • Fixes #___
  • Related to #___

📸 Screenshots/Examples

Before

<!-- Show the old behavior -->

After

<!-- Show the new behavior -->

📋 Checklist

Code Quality

  • My code follows the project's style guidelines
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings or errors

Testing

  • 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
  • I have tested the VS Code extension manually (if applicable)

Documentation

  • I have made corresponding changes to the documentation
  • I have updated the CHANGELOG.md (if applicable)
  • My changes don't break existing API contracts

Dependencies & Performance

  • I have considered the impact on bundle size
  • I have tested startup performance impact
  • No new dependencies added without justification

🚨 Breaking Changes

  • This PR introduces breaking changes
  • Migration guide provided (if breaking changes)

🔮 Future Considerations

📝 Notes for Reviewers

Priority: High / Medium / Low
Review Focus: Logic / Performance / Security / UX / Documentation

Ready for review! 🧶✨