Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (26 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

46 lines (26 loc) · 2.69 KB
Raw

Contributing to OpenDriverInterface

First off, thank you for considering contributing to OpenDriverInterface. Your contributions help make this project better and more accessible to the community.

Please take a moment to review this document for some guidelines on how to contribute.

Code of Conduct

Please note that this project has adopted a Code of Conduct. By participating in this project, you are expected to uphold this code. Please report unacceptable behavior to contact@opendriverinterface.com.

How Can I Contribute?

There are several ways you can contribute to OpenDriverInterface:

  1. Reporting Bugs: If you encounter a bug or unexpected behavior, please open an issue on our GitHub repository. Make sure to include as much detail as possible.

  2. Suggesting Enhancements: If you have ideas for new features or improvements, feel free to suggest them by opening an issue on GitHub.

  3. Contributing Code: If you want to contribute code to OpenDriverInterface, please follow these steps:

    • Fork the project repository.
    • Create a new branch for your feature or bug fix, from the development branch.
    • Name it feature/<feature-name> or bugfix/<bug-name>.
    • Write code, tests, and documentation for your changes.
    • Ensure that your code follows the project's coding standards.
    • Submit a pull request (PR) to the repository's development branch.

  4. Improving Documentation: If you find inaccuracies or omissions in the project's documentation, please consider opening a PR with your improvements.

Code Style

OpenDriverInterface follows a specific code style to maintain consistency throughout the codebase. Please review the existing code and ensure that your contributions conform to this style. If you are unsure about something, feel free to ask.

Testing

Before submitting a pull request, make sure to test your changes thoroughly. If your code introduces new features, write corresponding tests. Also, ensure that all existing tests pass successfully. All tests should be tested against the standard test suite.

Licensing

By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.

Contact

If you have questions, need assistance, or want to discuss your contributions, you can contact us at contact@opendriverinterface.com.

We appreciate your interest in contributing to OpenDriverInterface. Your contributions help make this project better for everyone in the community.