Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
21 lines (19 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

21 lines (19 loc) · 1.48 KB

We are constantly trying to extend the library, improve the user experience and the documentation. Any contribution or feedback is highly appreciated. We welcome contributions of all kinds, including bug reports, feature requests, documentation improvements, and code contributions.

How to contribute

If you would like to contribute to CLUEstering, please follow these guidelines:

  1. Fork the repository and create your branch from main.
  2. Create a new branch for your feature or bug fix with 
    git switch -c <branch-name>
    NOTE: Please use a standard radix for the name of your branch, e.g. feature/, docs/, fix/, refactor/, chore/.
  3. Add your changes and commit them with a clear and concise message. Also make sure that the source files, as well as the CMake files, are formatted using respectively clang-format and cmake-format.
  4. Push your branch to your forked repository.
  5. Create a pull request to the main branch of the original repository. Please make sure to provide a clear description of your changes and the motivation behind them.

Opening an issue

If you encounter a bug or have a feature request, please open an issue on GitHub. When opening an issue, please provide as much detail as possible. If you are reporting a bug, please include steps to reproduce the issue, as well as any relevant error messages or logs.

Licensing

By contributing to this project, you agree that your contributions will be licensed under the MPL-2.0 license.