CityTrack / .github /PULL_REQUEST_TEMPLATE.md
0xarchit's picture
Initial commit: CityTrack MVP with documentation, templates, and license
15cfc64

Pull Request: [Brief Title]

Description

Please include a summary of the changes and related context. Why is this change being made?

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 change)
  • Documentation update
  • Performance improvement
  • Code refactoring
  • Testing enhancement

Related Issue

Closes #(issue number)

Changes Made

Describe the specific changes in this PR:

  • Change 1: ...
  • Change 2: ...
  • Change 3: ...

Testing

Describe what tests you've run and how to reproduce them:

Test Cases

  • Test case 1: ...
  • Test case 2: ...
  • Edge case: ...

Manual Testing Steps

  1. Step 1
  2. Step 2
  3. Expected result: ...

Affected Components

Which parts of CityTrack are affected?

  • Mobile App
  • Admin Dashboard
  • Worker Portal
  • Backend API
  • Database
  • AI/ML Pipeline
  • Documentation
  • Other: ___________

Breaking Changes

List any breaking changes and migration steps if applicable:

  • Breaking change 1:
    • Migration: ...

Checklist

  • My code follows the code style 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/feature works
  • New and existing unit tests passed locally with my changes
  • Any dependent changes have been merged and published
  • I've updated the CHANGELOG (if applicable)

Performance Impact

  • No performance impact
  • Performance improvement (describe: ...)
  • Performance impact (describe: ... and why it's necessary)

Security Considerations

Are there any security implications?

  • No security concerns
  • Security improvement (describe the fix: ...)
  • Requires security review (describe the change: ...)

Screenshots (if applicable)

Add screenshots for UI changes:

Before After
[Screenshot] [Screenshot]

Additional Notes

Any additional information reviewers should know?


Reviewer Notes:

  • Review focus areas: ...
  • Questions for reviewers: ...