libmbedtls/mbedtls/CONTRIBUTING.md

7 -----------------------------------
10 - [Sign-off](#license-and-copyright): all commits must be signed off.
11 - [Tests](#tests): please ensure the PR includes adequate tests.
12 - [Changelog](#documentation): if needed, please provide a changelog entry.
13 - [Backports](#long-term-support-branches): provide a backport if needed (it's fine to wait until t…
16 ----------------
17 - Contributions should include tests, as mentioned in the [Tests](#tests) and [Continuous Integrati…
18 - The code should be written in a clean and readable style, and must follow [our coding standards](…
19 - The code should be written in a portable generic way, that will benefit the whole community, and …
20 - The code should be secure, and will be reviewed from a security point of view as well.
23 ---------------------
24 …es](https://github.com/Mbed-TLS/mbedtls/issues) or [start a discussion](https://lists.trustedfirmw…
25 …hub.com/Mbed-TLS/mbedtls) to start making your changes. As a general rule, you should use the ["de…
27 …ry. See our [review process guidelines](https://mbed-tls.readthedocs.io/en/latest/reviews/review-f…
28 1. For quick merging, the contribution should be short, and concentrated on a single feature or top…
31 -----------------------
33 …aintained between different versions of Mbed TLS on the main development branch and in LTS (Long T…
35 …is required, all changes to the ABI or API, even on the main development branch where new features…
42 --------------------------
48 … that correct a defect that is also present in an LTS branch must be backported to that LTS branch…
51 … backported to LTS branches in addition to the [development branch](https://github.com/Mbed-TLS/mb…
54 of BRANCHES.md](BRANCHES.md#current-branches).
57 -----
62 …w to add additional tests is available on the Mbed TLS website](https://mbed-tls.readthedocs.io/en…
64 A test script `tests/scripts/basic-build-test.sh` is available to show test coverage of the library…
69 ----------------------------
72 …to enable the [githooks scripts](https://github.com/Mbed-TLS/mbedtls/tree/development/tests/git-sc…
75 -------------
81 1. If a [Knowledge Base (KB)](https://mbed-tls.readthedocs.io/en/latest/kb/) article should be adde…
82 1. A [ChangeLog](https://github.com/Mbed-TLS/mbedtls/blob/development/ChangeLog.d/00README.md) entr…
85 ---------------------
87 …d under a dual [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) OR [GPL-2.0-or-later](https…
89 …contributions are made under both the Apache-2.0 AND [GPL-2.0-or-later](https://spdx.org/licenses/…
91 …rd SPDX license identifier where possible, i.e. "SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or…
95 …become part of the project, and is submitted under both the Apache-2.0 AND GPL-2.0-or-later licens…
97 …t `Signed-off-by:` line in every commit message. If more than one person contributed to the commit…