Skip to content

pull_request_template.md

Latest commit

 

History

History
376 lines (245 loc) · 7.13 KB

pull_request_template.md

File metadata and controls

376 lines (245 loc) · 7.13 KB
Raw

Pull Request

📋 Description

What does this PR do?

Why is this change necessary?

🔗 Related Issues

Fixes #(issue number) 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
  • 🎨 Code style update (formatting, renaming)
  • ♻️ Code refactoring (no functional changes)
  • ⚡ Performance improvement
  • ✅ Test update
  • 🔧 Build configuration change
  • 🔒 Security fix
  • 🌐 Internationalization/localization
  • 🗑️ Code removal/deprecation

🧪 How Has This Been Tested?

Test Environment:

  • OS: [e.g., Ubuntu 22.04]
  • Node.js: [e.g., v18.17.0]
  • Database: [e.g., MariaDB 10.11]

Test Cases:

  1. Test 1:

    • Description:
    • Steps:
    • Result: ✅ Pass / ❌ Fail

  2. Test 2:

    • Description:
    • Steps:
    • Result: ✅ Pass / ❌ Fail

Manual Testing:

  • Tested locally in development
  • Tested in production-like environment
  • Tested with sample data
  • Tested edge cases

Automated Testing:

  • Added unit tests
  • Added integration tests
  • All existing tests pass
  • New tests pass
# Test results
npm test
# ✅ 45 passing
# ❌ 0 failing

📸 Screenshots (if applicable)

Before:

Before

After:

After

📝 Changes Made

Added

  • Feature/file added
  • New endpoint: POST /api/...
  • New utility function: UtilityName()

Changed

  • Modified file: src/Services/ServiceName.ts
  • Updated behavior of...
  • Improved performance of...

Removed

  • Removed deprecated method: OldMethod()
  • Deleted unused file: OldFile.ts

Fixed

  • Fixed bug in...
  • Resolved issue with...

🔧 Configuration Changes

  • Requires environment variable updates
  • Requires database migration
  • Requires configuration file changes
  • Requires dependency installation

New Environment Variables:

# Add these to .env
NEW_VARIABLE=value

Database Migrations:

-- Add migration script if needed
ALTER TABLE...

📚 Documentation

  • Updated README.md
  • Updated API documentation
  • Updated inline code comments
  • Updated CHANGELOG.md
  • Added JSDoc comments
  • Updated Postman collection
  • No documentation needed

⚠️ Breaking Changes

Does this PR introduce breaking changes?

  • Yes
  • No

If yes, describe:

  1. What breaks:
  2. Why:
  3. Migration path:

Example:

// Old way (deprecated)
const result = await service.OldMethod();

// New way
const result = await service.NewMethod();

🚀 Deployment Notes

Pre-deployment:

  • Run database migrations
  • Update environment variables
  • Install new dependencies
  • Other: ___

Post-deployment:

  • Verify new feature works
  • Check logs for errors
  • Monitor performance
  • Other: ___

Rollback Plan:

  • How to rollback if issues occur:

✅ Pre-submission 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 code follows SOLID principles
  • I have used PascalCase for classes, interfaces, and class methods
  • I have used camelCase for variables and function parameters

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 edge cases
  • I have tested error scenarios

Documentation

  • I have made corresponding changes to the documentation
  • I have updated the CHANGELOG.md file
  • I have added/updated JSDoc comments for public methods
  • I have updated the Postman collection (if API changes)

Linting & Formatting

  • My code passes linting (npm run lint)
  • My code is formatted with Prettier (npm run format)
  • There are no TypeScript errors (npm run build)
  • There are no console.log statements left in the code

Security

  • I have reviewed my changes for security vulnerabilities
  • I have not exposed any secrets or credentials
  • I have validated all user inputs
  • I have considered authentication/authorization requirements

Dependencies

  • I have not added unnecessary dependencies
  • All new dependencies are from trusted sources
  • I have updated package.json (if dependencies changed)

👀 Reviewers Needed

@maintainer1 @maintainer2

Specific review focus:

  • Code architecture
  • Security review
  • Performance review
  • Documentation review

💬 Additional Notes

📊 Code Coverage

Before:

Coverage: 85%

After:

Coverage: 87% (+2%)

🔄 Migration Guide (for breaking changes)

### For Users

1. Step one
2. Step two
3. Step three

### For Contributors

1. Update import statements:
   ```typescript
   // Old
   import { OldClass } from './old';

   // New
   import { NewClass } from './new';

  1. Update usage:

    // Old
const result = await oldMethod();

// New
const result = await newMethod();

---

## 📈 **Performance Impact**

<!-- If applicable, describe performance improvements or regressions -->

**Benchmarks:**

| Operation | Before | After | Improvement |
|-----------|--------|-------|-------------|
| API Call | 120ms | 80ms | 33% faster |
| Database Query | 45ms | 30ms | 33% faster |

---

## 🎯 **Future Improvements**

<!-- Optional: List potential future enhancements related to this PR -->

- [ ] Future enhancement 1
- [ ] Future enhancement 2
- [ ] Future enhancement 3

---

**Thank you for contributing to Deploy Center!** 🚀

<!--
Once submitted, maintainers will review your PR. Please be patient and responsive to feedback.
You can track the status of your PR in the Checks tab.
-->