Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (47 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

65 lines (47 loc) · 2.54 KB

Contributing

We greatly appreciate your contributions! However, there exists numerous cases where unclear licensing hindered uses and contributions or further led to litigation. We therefore establish the following requirements for making contributions. We do not mean to be overly restrictive; we want to ensure that the project remains free and open.

To contribute to this project, you need to certify the Developer Certificate of Origin, Version 1.1, shown below.

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

To acknowledge your consent, include the Signed-off-by trailer in each commit message with your legal name and valid e-mail address (e.g., Signed-off-by: Alice P. Liddell <alice@example.org>).

To declare license and copyright, add SPDX file tags appropriately to each file.

Additionally, we recommend these items:

  • Include minimum changes in a commit if possible.
  • Follow the coding standard by running ClangFormat for C++ files.
  • Eliminate compile warnings and errors if possible.
  • Make sure the tests runs without errors, or correct the tests to pass.

Comments, issues, and patches are welcome currently via GitHub.