Skip to content

Latest commit

 

History

History
85 lines (54 loc) · 3.63 KB

CONTRIBUTING.md

File metadata and controls

85 lines (54 loc) · 3.63 KB
Raw

Contributing to Zserio

The following summarizes the process for contributing changes to the Zserio project.

Where to start

General rules for any code contribution

  • Consider to open a discussion or create an issue.

  • Open a new GitHub pull request.

  • Follow our coding style.

    • For all C++ and Java code we use clang-format to check that the code follows the defined coding style.

      Note that you have to run clang-format on your own, our pipeline only checks that the code follows the rules.

      clang-format --style=file -i source.cpp

    • For Python code we use black to check that the code follows the defined coding style, which is basically PEP-8 with line length limited to 112 characters.

      Note that you have to run black on your own, our pipeline only checks that the code follows the rules.

      black source.py --line-length 112

  • Ensure that all GitHub workflows are passing.

  • Wait for the review by @Mi-La or @mikir.

Please try to address only a single problem in you pull request.

Did you find a bug?

Do you want to propose a performance optimization?

Do you want to propose a new feature?

Do you intend to write a new generator?

  • Consider to open a discussion or create an issue.

  • In case you want to implement a new generator (i.e. zserio extension), you can start with Zserio Extension Sample and keep it as an external extension. We will be happy to add a link to your extension in our README.md!

License

We do not require any formal copyright assignment or contributor license agreement (CLA). Any contributions intentionally sent upstream are presumed to be offered under terms of BSD 3-Clause License. See LICENSE for details.