blob: c58334b85b866a75b7922dc8201e2474b72bb53c [file] [log] [blame]
Galanakis, Minos41f85972019-09-30 15:56:40 +01001Contributing
2============
Gyorgy Szingdb9783c2019-04-17 21:08:48 +02003
4Contributions to TF-M project need to follow the process below.
5
Galanakis, Minos09072612019-07-04 16:23:10 +01006``Note`` Please contact :doc:`/docs/maintainers` for any questions.
Gyorgy Szingdb9783c2019-04-17 21:08:48 +02007
8- Create an issue in http://issues.trustedfirmware.org
9 to keep others informed about your ongoing work.
10- If it is a major change then please discuss the design with
11 maintainers.
12- Clone the TF-M code on your own machine from
13 http://git.trustedfirmware.org/trusted-firmware-m.git
14- Follow the :doc:`Coding Guide </docs/coding_guide>` for the TF-M
15 project.
16- Make your changes in logical chunks to help reviewers.
17- Update relevant documentation.
18- Test your changes and add details to the commit description.
19- Add the issue number and details to commit description as well.
20- The code is accepted under :doc:`DCO </docs/dco>`, Developer
21 Certificate of Origin, so you must add following fields to your commit
22 description.::
23
24 Author: Full Name <email address>
25 Signed-off-by: Full Name <email address>
26
27 Note: Sign off authority needs to adhere to the [DCO](./dco.txt) rules.
28
29- You may add other fields in the commit message.
30- Submit your patch for review at
31 http://review.trustedfirmware.org
32- Maintainers will be notified and they will start review process.
33- You may be asked to provide further details or make additional
34 changes.
35- You can discuss further with maintainer(s) offline if necessary.
36- | Once the change is approved by maintainers, the patch can be
37 submitted
38 | either by maintainer or patch owner.
39
40--------------
41
42*Copyright (c) 2017-2019, Arm Limited. All rights reserved.*