Commit graph

38 commits

Author SHA1 Message Date
Dave Rodgman
2c9049c406 Update documentation
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2023-11-03 12:25:20 +00:00
Tom Cosgrove
2be22a00eb
Update CONTRIBUTING.md
Co-authored-by: Dave Rodgman <dave.rodgman@arm.com>
Signed-off-by: Tom Cosgrove <tom.cosgrove@arm.com>
2023-07-26 12:32:34 +01:00
Tom Cosgrove
f884e603b9 Have a single source of truth for licensing information
We had information in both README.md and CONTRIBUTING.md about Mbed TLS licensing,
but the information in CONTRIBUTING.md was missing that authors still need to
accept that their contributions may be distributed under both Apache 2.0 and
GPLv2-or-later.

Move all but the most high-level “Mbed TLS files are provided under the
Apache-2.0 license” statement to CONTRIBUTING.md, and tidy up the text a bit.

Signed-off-by: Tom Cosgrove <tom.cosgrove@arm.com>
2023-07-26 11:46:31 +01:00
Manuel Pégourié-Gonnard
43fb9c83d8 Add link to review guideline fro contributors
Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
2023-04-21 11:19:44 +02:00
Gilles Peskine
d7271187ca 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 <Gilles.Peskine@arm.com>
2023-01-13 12:08:50 +01:00
David Horstmann
9b1144d5bc Minor grammatical fix
Signed-off-by: David Horstmann <david.horstmann@arm.com>
2022-11-08 19:13:58 +00:00
David Horstmann
c1cc7a4c76 Merge and reorder paragraphs for clarity
Signed-off-by: David Horstmann <david.horstmann@arm.com>
2022-11-08 19:13:15 +00:00
David Horstmann
70dc3e2895 Reword the documentation for deprecation
Change the wording of the section of CONTRIBUTING.md on function
deprecation to make it easier to understand.

Signed-off-by: David Horstmann <david.horstmann@arm.com>
2022-11-07 18:31:22 +00:00
Dave Rodgman
b256640d72 Improve list formatting
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-11-01 20:40:48 +00:00
Dave Rodgman
f3928fb3e0 Reinstate note about all PRs receiving review
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-11-01 20:39:04 +00:00
Dave Rodgman
119e5d7a6b Update CONTRIBUTING.md, and refer to this from the template
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-10-31 15:57:31 +00:00
Gilles Peskine
42832bd406 Don't use test_suite_mpi as an example
It just got renamed, and it's also not the most canonical example since it's
a somewhat deprecated interface. Make a different module the example.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2022-10-21 18:56:47 +02:00
Dave Rodgman
7c195160df Update documentation links
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-10-12 16:27:14 +01:00
Dave Rodgman
f184625223 Clarify legal requirements for contributions
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-09-15 11:52:44 +01:00
Janos Follath
3af3415d89 Fix LTS version in contributing guidelines
The LTS branch hasn't been updated in the contributing guidelines.
Deleting it instead of updating as the information is available at the
link above and deleting prevents similar mistakes in the future.

Signed-off-by: Janos Follath <janos.follath@arm.com>
2022-04-04 10:46:58 +01:00
Dave Rodgman
017a19997a Update references to old Github organisation
Replace references to ARMmbed organisation with the new
org, Mbed-TLS, following project migration.

Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-03-31 14:43:16 +01:00
Janos Follath
88addc4883 Update mailing list links
The mailing list software has been updated and the links have changed.

Signed-off-by: Janos Follath <janos.follath@arm.com>
2022-01-12 13:09:17 +00:00
Tom Cosgrove
fff613aa10 Fix list of LTS braches in CONTRIBUTING.md, and back link from BRANCHES.md
Signed-off-by: Tom Cosgrove <tom.cosgrove@arm.com>
2021-11-15 13:54:59 +00:00
Manuel Pégourié-Gonnard
80c02af03c Add cross-doc links, avoid redundancies
Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
2021-02-25 12:50:43 +01:00
Janos Follath
eee1f3b0c1
Merge pull request #3341 from paul-elliott-arm/fix-contributing
Fix contributing link to changelog howto
2020-05-27 07:44:25 +01:00
Paul Elliott
8c4fd40bf6 Change Changelog link to point at Changelog readme
Make the contributing document link to how to create a changelog rather
than just linking to the Changelog itself.

Signed-off-by: Paul Elliott <paul.elliott@arm.com>
2020-05-21 16:25:56 +01:00
Janos Follath
a85c2b27f3 Update link in contributing guide
The link pointed to the website, this information is out of date, the
correct place to start discussions is the mailing list.

Signed-off-by: Janos Follath <janos.follath@arm.com>
2020-05-06 11:11:39 +01:00
Dan Handley
16a988527f Minor formatting fixes to CONTRIBUTING.md
Fix inconsistent list formatting in CONTRIBUTING.md.

Signed-off-by: Dan Handley <dan.handley@arm.com>
2020-02-19 15:50:52 +00:00
Dan Handley
c76a54554c Drop requirement for a CLA
The Mbed TLS project no longer requires a CLA. Contributions from now on
must be made under both Apache-2.0 AND GPL-2.0-or-later licenses, to enable
LTS (Long Term Support) branches of the software to continue to be provided
under either Apache-2.0 OR GPL-2.0-or-later. Contributors must accept the
terms of the Developer Certificate of Origin (DCO) by adding a Signed-off-by:
line to each commit message.

The software on the development branch continues to be provided under
Apache-2.0.

Update README.md, CONTRIBUTING.md and pull_request_template.md to explain
the new licensing model. Add a copy of the DCO to the project.

Expand the full Apache-2.0 license text in the LICENSE file and remove the
redundant apache-2.0.txt.

Signed-off-by: Dan Handley <dan.handley@arm.com>
2020-02-19 15:50:40 +00:00
Antonin Décimo
36e89b5b71 Fix #2370, minor typos and spelling mistakes 2019-01-24 10:37:40 +01:00
Ron Eldor
0caddf770f Update the LTS branch list in the contributing doc
1. Remove the reference to `mbedtls-2.1` since it's End Of Life.
2. Add reference to `mbedtls-2.16` since it's a new LTS branch.
2019-01-02 10:58:25 +02:00
Simon Butcher
269e999a35 Remove unnecessary newlines in CONTRIBUTING.md 2018-07-24 17:21:00 +01:00
Simon Butcher
6965f771de Fix use of Knowledge Base in documentation
Made the use of 'Knowledge Base' consistent in the CONTRIBUTING.md and
README.md files.
2018-07-23 23:59:24 +01:00
Simon Butcher
5a5d03f025 Add test guidelines to CONTRIBUTING.md 2018-07-23 16:16:04 +01:00
Simon Butcher
10f9663fcb Added clarification to CONTRIBUTING.md
Added rationale as to when API changes are permitted, and clarified why we
try to preserve the API/ABI.
2018-07-23 16:10:36 +01:00
Simon Butcher
7870ec12c4 Add API/ABI section to CONTRIBUTING.md
Added a section on API/ABI compatibility on the development branch to the
CONTRIBUTING.md guidelines. Also added to the testing section, refined the LTS
section and changed some formatting for consistency.
2018-07-20 19:39:10 +01:00
Simon Butcher
d50f7865ea Update the CONTRIBUTING.md file for LTS branches
The CONTRIBUTING.md referred to 'legacy' branches instead of LTS branches, and
also referenced mbedtls-1.3 which is no longer maintained, and omitted
mbedtls-2.7 which is.
2018-07-03 16:11:44 +01:00
Ron Eldor
b2231fc31a Address review comments
Addres review comments done by Hanno
2017-09-10 17:34:28 +03:00
Ron Eldor
0a47d12717 Rephrase the backport sectio
Rephrase the backport sectoin, since development branch is not a legacy
branch
2017-09-03 10:20:25 +03:00
Ron Eldor
ea24d75c67 Addres Andres' comment
Update the document after Andres review comments
2017-08-31 17:02:01 +03:00
Ron Eldor
1680d3dc19 Add a couple of statements to the contribution section
Add a notice for short contributions, and for Apache license header that
should be added. Added an adivce to enable the git hooks scripts as well.
2017-08-20 16:46:43 +03:00
Ron Eldor
7f888982fd Modify Contribution Guidelines after comments
Modify the Contribution guidelines after comments from Gilles, Andres and
Jaeden
2017-08-16 16:59:29 +03:00
Ron Eldor
b5e6a77010 Add Contribution guidelines to github
Add Contribution Guidelines that will be shown in github, when PRs are
made.
2017-08-16 11:30:07 +03:00