Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (30 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

41 lines (30 loc) · 1.21 KB
Raw

Contributing to Traffic Automation Pro

Thank you for your interest in contributing to this project. We welcome bug reports, pull requests, and ideas that improve reliability, maintainability, and usability.

How to contribute

  1. Fork the repository.
  2. Create a feature branch from main: 
    

    3. 



git checkout -b feature/your-feature-name


3. Make your changes and keep commits focused and atomic.
4. Run the build and validate the project:
   ```bash
npm install
cd frontend && npm install
npm run build



    

  1. Submit a pull request describing your changes and why they are useful.
    2. 



Reporting issues


    

  • Use the GitHub issue tracker for bugs, security concerns, and feature requests.
    • 

  • Provide a clear description, reproduction steps, and expected behavior.
    • 

  • If appropriate, include log output and configuration details.
    • 



Code style


    

  • Use descriptive variable and function names.
    • 

  • Keep documentation up to date.
    • 

  • Prefer minimal and maintainable solutions.
    • 



Branch policy


    

  • Keep the main branch stable.
    • 

  • Target main with pull requests.
    • 

  • Rebase or merge main before submitting if there are conflicts.
    • 



License


By contributing, you agree that your contributions will be licensed under the MIT License.