Skip to content

Latest commit

 

History

History
67 lines (41 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

67 lines (41 loc) · 2.86 KB

Contributing Guidelines

Welcome to the Traffic Network Optimization project! We appreciate your interest in contributing to our project. The goal of this document is to provide guidelines for contributing to this project. By contributing to this project, you agree to abide by these guidelines.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

How to Contribute

There are many ways to contribute to this project. Here are some examples:

  • Reporting a bug
  • Suggesting a new feature
  • Writing or improving documentation
  • Fixing a bug or implementing a new feature

Before contributing, please make sure that you have read and understood the README.md file.

Reporting a Bug

If you find a bug in the project, please follow these steps:

  1. Search the issue tracker to see if the bug has already been reported.
  2. If the bug has not been reported, open a new issue and include a detailed description of the bug, including steps to reproduce it.
  3. If the bug has already been reported, add any additional information or steps to reproduce the bug to the existing issue.

Suggesting a New Feature

If you have an idea for a new feature, please follow these steps:

  1. Search the issue tracker to see if the feature has already been suggested.
  2. If the feature has not been suggested, open a new issue and include a detailed description of the feature.
  3. If the feature has already been suggested, add any additional information or ideas to the existing issue.

Writing or Improving Documentation

If you would like to help improve the project's documentation, please follow these steps:

  1. Fork the project on GitHub.
  2. Make your changes to the documentation.
  3. Submit a pull request with your changes.

Fixing a Bug or Implementing a New Feature

If you would like to fix a bug or implement a new feature, please follow these steps:

  1. Fork the project on GitHub.
  2. Make your changes to the code.
  3. Write tests to cover your changes.
  4. Make sure that all tests pass.
  5. Submit a pull request with your changes.

Pull Request Guidelines

Before submitting a pull request, please make sure that:

  • Your code is well-documented.
  • Your code adheres to the MATLAB Style Guidelines.
  • Your code passes all existing tests.
  • You have written tests to cover your changes.

Conclusion

Thank you for considering contributing to the Traffic Network Optimization project. We appreciate your time and effort. If you have any questions or comments, please feel free to open an issue or contact the project maintainers.