Skip to content

Latest commit

 

History

History
41 lines (21 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

41 lines (21 loc) · 2.25 KB
Raw

Contributing to RouteXplorer

Thank you for your interest in contributing to RouteXplorer! We welcome contributions from the community to help improve the library and make it even more powerful.

To contribute to RouteXplorer, please follow the guidelines below:

Issues

If you encounter any issues or bugs while using RouteXplorer, please check if the issue has already been reported in the issue tracker. If not, you can create a new issue providing detailed information about the problem, including steps to reproduce and any relevant error messages.

Feature Requests

If you have a suggestion or a new feature idea for RouteXplorer, please check the issue tracker to see if it has been discussed before. If not, feel free to open a new issue describing the feature request and its potential benefits.

Pull Requests

We appreciate and encourage pull requests from the community. If you want to contribute a new feature or bug fix to RouteXplorer, please follow these steps:

  1. Fork the RouteXplorer repository and create a new branch for your feature or bug fix.

  2. Implement your changes, ensuring that the code follows the project's coding style and conventions.

  3. Write tests for your code changes to maintain code quality and integrity.

  4. Update the documentation if necessary, including code examples and README.md.

  5. Commit your changes and push them to your forked repository.

  6. Submit a pull request to the main RouteXplorer repository. Provide a detailed description of your changes and reference any related issues.

  7. Participate in the review process, address any feedback or suggestions, and collaborate with the maintainers to get your changes merged into the main repository.

Code Style

Please follow the existing code style and conventions used in the RouteXplorer project to maintain code consistency. You can use linters or code formatters to help ensure your code adheres to the style guidelines.

License

By contributing to RouteXplorer, you agree that your contributions will be licensed under the MIT License. For more information, see the LICENSE.md file.

Thank you for your contribution to RouteXplorer! Together, we can make it even better.