Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (35 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

49 lines (35 loc) · 1.65 KB
Raw

Contributing to WiBLE

Thank you for your interest in contributing to WiBLE! We welcome contributions from the community to help make this library better.

Code of Conduct

Please be respectful and considerate of others when contributing to this project.

How to Contribute

  1. Fork the repository on GitHub.
  2. Create a new branch for your feature or bug fix: 
    git checkout -b feature/my-new-feature
  3. Make your changes and ensure they follow the project's coding style.
  4. Run tests to verify your changes: 
    pio test -e native
  5. Commit your changes with descriptive commit messages.
  6. Push to your branch: 
    git push origin feature/my-new-feature
  7. Submit a Pull Request to the main branch.

Coding Style

  • We follow the Google C++ Style Guide.
  • Use clang-format to format your code before submitting.
  • Ensure all new features are accompanied by unit tests.

Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub. Provide as much detail as possible, including:

  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Hardware and software versions

Good First Issues

If you are new to the project, check out the Good First Issue label on our issue tracker. These are tasks that are perfect for beginners to get started with WiBLE.

License

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