aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
AgeCommit message (Collapse)AuthorFilesLines
2023-11-03Remove not-needed sentenceDave Rodgman1-1/+1
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2023-11-02Update documentationDave Rodgman1-2/+2
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2023-07-26Update CONTRIBUTING.mdTom Cosgrove1-1/+1
Co-authored-by: Dave Rodgman <dave.rodgman@arm.com> Signed-off-by: Tom Cosgrove <tom.cosgrove@arm.com>
2023-07-26Have a single source of truth for licensing informationTom Cosgrove1-2/+8
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-04-21Add link to review guideline fro contributorsManuel Pégourié-Gonnard1-1/+1
Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
2023-01-13Improve test and coding standards overviewGilles Peskine1-2/+2
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>
2022-11-08Minor grammatical fixDavid Horstmann1-1/+1
Signed-off-by: David Horstmann <david.horstmann@arm.com>
2022-11-08Merge and reorder paragraphs for clarityDavid Horstmann1-3/+1
Signed-off-by: David Horstmann <david.horstmann@arm.com>
2022-11-07Reword the documentation for deprecationDavid Horstmann1-4/+2
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-01Improve list formattingDave Rodgman1-4/+4
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-11-01Reinstate note about all PRs receiving reviewDave Rodgman1-1/+2
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-10-31Update CONTRIBUTING.md, and refer to this from the templateDave Rodgman1-4/+10
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-10-21Don't use test_suite_mpi as an exampleGilles Peskine1-1/+1
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-12Update documentation linksDave Rodgman1-3/+3
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-09-15Clarify legal requirements for contributionsDave Rodgman1-2/+9
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-04-04Fix LTS version in contributing guidelinesJanos Follath1-4/+0
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-03-31Update references to old Github organisationDave Rodgman1-6/+6
Replace references to ARMmbed organisation with the new org, Mbed-TLS, following project migration. Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-01-12Update mailing list linksJanos Follath1-1/+1
The mailing list software has been updated and the links have changed. Signed-off-by: Janos Follath <janos.follath@arm.com>
2021-11-15Fix list of LTS braches in CONTRIBUTING.md, and back link from BRANCHES.mdTom Cosgrove1-2/+1
Signed-off-by: Tom Cosgrove <tom.cosgrove@arm.com>
2021-02-25Add cross-doc links, avoid redundanciesManuel Pégourié-Gonnard1-3/+7
Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
2020-05-27Merge pull request #3341 from paul-elliott-arm/fix-contributingJanos Follath1-1/+1
Fix contributing link to changelog howto
2020-05-21Change Changelog link to point at Changelog readmePaul Elliott1-1/+1
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-06Update link in contributing guideJanos Follath1-1/+1
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-02-19Minor formatting fixes to CONTRIBUTING.mdDan Handley1-16/+7
Fix inconsistent list formatting in CONTRIBUTING.md. Signed-off-by: Dan Handley <dan.handley@arm.com>
2020-02-19Drop requirement for a CLADan Handley1-6/+2
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>
2019-01-24Fix #2370, minor typos and spelling mistakesAntonin Décimo1-1/+1
2019-01-02Update the LTS branch list in the contributing docRon Eldor1-2/+2
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.
2018-07-24Remove unnecessary newlines in CONTRIBUTING.mdSimon Butcher1-5/+2
2018-07-23Fix use of Knowledge Base in documentationSimon Butcher1-1/+1
Made the use of 'Knowledge Base' consistent in the CONTRIBUTING.md and README.md files.
2018-07-23Add test guidelines to CONTRIBUTING.mdSimon Butcher1-0/+2
2018-07-23Added clarification to CONTRIBUTING.mdSimon Butcher1-13/+7
Added rationale as to when API changes are permitted, and clarified why we try to preserve the API/ABI.
2018-07-20Add API/ABI section to CONTRIBUTING.mdSimon Butcher1-13/+49
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-03Update the CONTRIBUTING.md file for LTS branchesSimon Butcher1-12/+15
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.
2017-09-10Address review commentsRon Eldor1-10/+10
Addres review comments done by Hanno
2017-09-03Rephrase the backport sectioRon Eldor1-2/+1
Rephrase the backport sectoin, since development branch is not a legacy branch
2017-08-31Addres Andres' commentRon Eldor1-31/+32
Update the document after Andres review comments
2017-08-20Add a couple of statements to the contribution sectionRon Eldor1-0/+3
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-16Modify Contribution Guidelines after commentsRon Eldor1-10/+30
Modify the Contribution guidelines after comments from Gilles, Andres and Jaeden
2017-08-16Add Contribution guidelines to githubRon Eldor1-0/+40
Add Contribution Guidelines that will be shown in github, when PRs are made.