From 12f4122068837041bb245fd1666b26bbcf7dd60c Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Fri, 13 Jan 2023 12:04:14 +0100 Subject: [PATCH 1/2] Announce coding style change in the changelog It doesn't affect users, but it affects some other external consumers of the library. Signed-off-by: Gilles Peskine --- ChangeLog.d/coding-style.txt | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 ChangeLog.d/coding-style.txt diff --git a/ChangeLog.d/coding-style.txt b/ChangeLog.d/coding-style.txt new file mode 100644 index 000000000..b2cff5cc0 --- /dev/null +++ b/ChangeLog.d/coding-style.txt @@ -0,0 +1,5 @@ +Changes + * The C code follows a new coding style. This is transparent for users but + affects contributors and maintainers of local patches. For more + information, see + https://mbed-tls.readthedocs.io/en/latest/kb/how-to/rewrite-branch-for-coding-style/ From d7271187ca5f96efa1a1a56066b9486c7bfc260a Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Fri, 13 Jan 2023 12:08:50 +0100 Subject: [PATCH 2/2] Improve test and coding standards overview Make testing and coding standards separate bullet points. For the coding standards, add a "must", since some of it is now enforced on the CI. For tests, don't ask for "fully tested before submission": we don't expect contributors to run all the tests locally. Ask for basic local testing, and remind users to check CI results after submission. Signed-off-by: Gilles Peskine --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fc79e49d2..a7bf198da 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,8 +14,8 @@ More details on all of these points may be found in the sections below. Coding Standards ---------------- -- We would ask that contributions conform to [our coding standards](https://mbed-tls.readthedocs.io/en/latest/kb/development/mbedtls-coding-standards/), and that contributions are fully tested before submission, as mentioned in the [Tests](#tests) and [Continuous Integration](#continuous-integration-tests) sections. -- The code should be written in a clean and readable style. +- Contributions should include tests, as mentioned in the [Tests](#tests) and [Continuous Integration](#continuous-integration-tests) sections. Please check that your contribution passes basic tests before submission, and check the CI results after making a pull request. +- The code should be written in a clean and readable style, and must follow [our coding standards](https://mbed-tls.readthedocs.io/en/latest/kb/development/mbedtls-coding-standards/). - The code should be written in a portable generic way, that will benefit the whole community, and not only your own needs. - The code should be secure, and will be reviewed from a security point of view as well.