diff options
| author | Dave Rodgman <dave.rodgman@arm.com> | 2022-10-31 15:57:31 +0000 |
|---|---|---|
| committer | Dave Rodgman <dave.rodgman@arm.com> | 2022-10-31 15:57:31 +0000 |
| commit | 119e5d7a6b379be074aa7a0452acb401a41e820d (patch) | |
| tree | 93930aea18ae5754ed02b18f07a7cec9d3ddf82f /CONTRIBUTING.md | |
| parent | 3d973314b22a840e047f910e6cfdc69ccdf354d1 (diff) | |
| download | mbedtls-119e5d7a6b379be074aa7a0452acb401a41e820d.zip mbedtls-119e5d7a6b379be074aa7a0452acb401a41e820d.tar.gz mbedtls-119e5d7a6b379be074aa7a0452acb401a41e820d.tar.bz2 | |
Update CONTRIBUTING.md, and refer to this from the template
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0e2cf49..0eca8ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,15 @@ Contributing ============ -We gratefully accept bug reports and contributions from the community. There are some requirements we need to fulfill in order to be able to integrate contributions: +We gratefully accept bug reports and contributions from the community. - - As with any open source project, contributions will be reviewed by the project team and community and may need some modifications to be accepted. - - The contribution should not break API or ABI, unless there is a real justification for that. If there is an API change, the contribution, if accepted, will be merged only when there will be a major release. +Quick Checklist for PR contributors +----------------------------------- +More details on all of these points may be found in the sections below. + +- [Sign-off](#license-and-copyright): all commits must be signed off +- [Tests](#tests): please ensure the PR includes adequate tests +- [Changelog](#documentation): if needed, please provide a changelog entry +- [Backports](#long-term-support-branches): provide a backport if needed (it's fine to wait until the main PR is accepted) Coding Standards ---------------- @@ -25,7 +31,7 @@ Backwards Compatibility The project aims to minimise the impact on users upgrading to newer versions of the library and it should not be necessary for a user to make any changes to their own code to work with a newer version of the library. Unless the user has made an active decision to use newer features, a newer generation of the library or a change has been necessary due to a security issue or other significant software defect, no modifications to their own code should be necessary. To achieve this, API compatibility is maintained between different versions of Mbed TLS on the main development branch and in LTS (Long Term Support) branches, as described in [BRANCHES.md](BRANCHES.md). -To minimise such disruption to users, where a change to the interface is required, all changes to the ABI or API, even on the main development branch where new features are added, need to be justifiable by either being a significant enhancement, new feature or bug fix which is best resolved by an interface change. +To minimise such disruption to users, where a change to the interface is required, all changes to the ABI or API, even on the main development branch where new features are added, need to be justifiable by either being a significant enhancement, new feature or bug fix which is best resolved by an interface change. If there is an API change, the contribution, if accepted, will be merged only when there will be a major release. Where changes to an existing interface are necessary, functions in the public interface which need to be changed, are marked as 'deprecated'. This is done with the preprocessor symbols `MBEDTLS_DEPRECATED_WARNING` and `MBEDTLS_DEPRECATED_REMOVED`. Then, a new function with a new name but similar if not identical behaviour to the original function containing the necessary changes should be created alongside the existing deprecated function. |