Skip to content

PULL_REQUEST_TEMPLATE.md

Latest commit

 

History

History
109 lines (74 loc) · 2.55 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

109 lines (74 loc) · 2.55 KB

Pull Request

Description

Clear and concise description of the changes

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 refactoring
  • Performance improvement
  • Test addition/improvement

Related Issues

Link to related issues

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

Changes Made

Detailed list of changes

  • Change 1
  • Change 2
  • Change 3

Affected Components

Which components are affected?

  • FL Server (src/fl/server/)
  • FL Client (src/fl/client/)
  • Policy Engine (src/policy_engine/)
  • Dashboard Frontend (dashboard/frontend/)
  • Dashboard Backend (dashboard/backend/)
  • Collector (src/collector/)
  • Networking/SDN (src/networking/)
  • Configuration (config/)
  • Documentation (docs/)
  • Scripts (scripts/)
  • Docker/Infrastructure (docker/)

Testing

How has this been tested?

  • Unit tests pass
  • Integration tests pass
  • Manual testing completed
  • New tests added

Test Configuration:

  • OS:
  • Python Version:
  • Node Version (if applicable):

Test Results:

# Paste test output here

Screenshots/GIFs

If applicable, add screenshots or GIFs showing the changes

Checklist

  • My code follows the code style of this project (see CONTRIBUTING.md)
  • 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 or errors
  • 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
  • I have checked my code and corrected any misspellings
  • I have updated the CHANGELOG (if applicable)
  • I have signed my commits (git commit -s)

Breaking Changes

If this is a breaking change, describe the impact and migration path

Rollback Plan

If applicable, describe how to rollback this change

Additional Notes

Any additional information for reviewers

Reviewer Guidelines

  • Verify all tests pass
  • Check code style and conventions
  • Review documentation updates
  • Test manually if UI/UX changes
  • Verify no security vulnerabilities introduced