Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (48 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

59 lines (48 loc) · 1.65 KB

Contributing to Python-Based Traffic Management System

Thank you for your interest in contributing! This project is open source and welcomes contributions from students, developers, and traffic engineering enthusiasts.

How to Contribute

Reporting Bugs

  • Open an issue on GitHub with the bug label
  • Include your OS, Python version, and steps to reproduce

Suggesting Features

  • Open an issue with the enhancement label
  • Describe the feature and why it would be useful

Submitting Code

  1. Fork the repository
  2. Clone your fork: 
    git clone https://github.com/YOUR_USERNAME/Python-Based-Traffic-Management-System.git
  3. Create a branch: 
    git checkout -b feature/your-feature-name
  4. Make your changes and test them
  5. Commit with a clear message: 
    git commit -m "Add: description of your change"
  6. Push and create a Pull Request

Code Style

  • Follow PEP 8
  • Add docstrings to all public classes and methods
  • Include type hints where possible
  • Write tests for new features

Testing

cd tests
python -m pytest test_controller.py -v

Project Structure

├── traffic_management_system.py   # Main application
├── config.py                       # Configuration
├── tests/                          # Unit tests
├── screenshots/                    # App screenshots
├── docs/                           # PDF guide & documentation
└── logs/                           # Exported CSV logs

Code of Conduct

Be respectful, inclusive, and constructive. We're all here to learn.

Powered by Liveupx.com & xHost