1Contributor's Guide 2=================== 3 4Getting Started 5--------------- 6 7- Make sure you have a Github account and you are logged on both 8 `developer.trustedfirmware.org`_ and `review.trustedfirmware.org`_. 9- Create an `issue`_ for your work if one does not already exist. This gives 10 everyone visibility of whether others are working on something similar. 11 12 - If you intend to include Third Party IP in your contribution, please 13 raise a separate `issue`_ for this and ensure that the changes that 14 include Third Party IP are made on a separate topic branch. 15 16- Clone `Trusted Firmware-A`_ on your own machine as described in 17 :ref:`prerequisites_get_source`. 18- Create a local topic branch based on the `Trusted Firmware-A`_ ``master`` 19 branch. 20 21Making Changes 22-------------- 23 24- Make commits of logical units. See these general `Git guidelines`_ for 25 contributing to a project. 26- Follow the :ref:`Coding Style` and :ref:`Coding Guidelines`. 27 28 - Use the checkpatch.pl script provided with the Linux source tree. A 29 Makefile target is provided for convenience. 30 31- Keep the commits on topic. If you need to fix another bug or make another 32 enhancement, please create a separate `issue`_ and address it on a separate 33 topic branch. 34- Avoid long commit series. If you do have a long series, consider whether 35 some commits should be squashed together or addressed in a separate topic. 36- Make sure your commit messages are in the proper format. If a commit fixes 37 an `issue`_, include a reference. 38- Where appropriate, please update the documentation. 39 40 - Consider whether the :ref:`Porting Guide`, 41 :ref:`Firmware Design` document or other in-source documentation needs 42 updating. 43 - Ensure that each changed file has the correct copyright and license 44 information. Files that entirely consist of contributions to this 45 project should have a copyright notice and BSD-3-Clause SPDX license 46 identifier of the form as shown in :ref:`license`. Files that contain 47 changes to imported Third Party IP files should retain their original 48 copyright and license notices. For significant contributions you may 49 add your own copyright notice in following format: 50 51 :: 52 53 Portions copyright (c) [XXXX-]YYYY, <OWNER>. All rights reserved. 54 55 where XXXX is the year of first contribution (if different to YYYY) and 56 YYYY is the year of most recent contribution. <OWNER> is your name or 57 your company name. 58 - If you are submitting new files that you intend to be the code owner for 59 (for example, a new platform port), then also update the 60 :ref:`code owners` file. 61 - For topics with multiple commits, you should make all documentation 62 changes (and nothing else) in the last commit of the series. Otherwise, 63 include the documentation changes within the single commit. 64 65- Please test your changes. As a minimum, ensure that Linux boots on the 66 Foundation FVP. See :ref:`Arm Fixed Virtual Platforms (FVP)` for more 67 information. For more extensive testing, consider running the `TF-A Tests`_ 68 against your patches. 69 70Submitting Changes 71------------------ 72 73- Ensure that each commit in the series has at least one ``Signed-off-by:`` 74 line, using your real name and email address. The names in the 75 ``Signed-off-by:`` and ``Author:`` lines must match. If anyone else 76 contributes to the commit, they must also add their own ``Signed-off-by:`` 77 line. By adding this line the contributor certifies the contribution is made 78 under the terms of the 79 :download:`Developer Certificate of Origin <../../dco.txt>`. 80 81 More details may be found in the `Gerrit Signed-off-by Lines guidelines`_. 82 83- Ensure that each commit also has a unique ``Change-Id:`` line. If you have 84 cloned the repository with the "`Clone with commit-msg hook`" clone method 85 (following the :ref:`Prerequisites` document), this should already be the 86 case. 87 88 More details may be found in the `Gerrit Change-Ids documentation`_. 89 90- Submit your changes for review at https://review.trustedfirmware.org 91 targeting the ``integration`` branch. 92 93 - The changes will then undergo further review and testing by the 94 :ref:`code owners` and :ref:`maintainers`. Any review comments will be 95 made directly on your patch. This may require you to do some rework. For 96 controversial changes, the discussion might be moved to the `TF-A mailing 97 list`_ to involve more of the community. 98 99 Refer to the `Gerrit Uploading Changes documentation`_ for more details. 100 101- When the changes are accepted, the :ref:`maintainers` will integrate them. 102 103 - Typically, the :ref:`maintainers` will merge the changes into the 104 ``integration`` branch. 105 - If the changes are not based on a sufficiently-recent commit, or if they 106 cannot be automatically rebased, then the :ref:`maintainers` may rebase it 107 on the ``integration`` branch or ask you to do so. 108 - After final integration testing, the changes will make their way into the 109 ``master`` branch. If a problem is found during integration, the 110 :ref:`maintainers` will request your help to solve the issue. They may 111 revert your patches and ask you to resubmit a reworked version of them or 112 they may ask you to provide a fix-up patch. 113 114Binary Components 115----------------- 116 117- Platforms may depend on binary components submitted to the `Trusted Firmware 118 binary repository`_ if they require code that the contributor is unable or 119 unwilling to open-source. This should be used as a rare exception. 120- All binary components must follow the contribution guidelines (in particular 121 licensing rules) outlined in the `readme.rst <tf-binaries-readme_>`_ file of 122 the binary repository. 123- Binary components must be restricted to only the specific functionality that 124 cannot be open-sourced and must be linked into a larger open-source platform 125 port. The majority of the platform port must still be implemented in open 126 source. Platform ports that are merely a thin wrapper around a binary 127 component that contains all the actual code will not be accepted. 128- Only platform port code (i.e. in the ``plat/<vendor>`` directory) may rely on 129 binary components. Generic code must always be fully open-source. 130 131-------------- 132 133*Copyright (c) 2013-2020, Arm Limited and Contributors. All rights reserved.* 134 135.. _developer.trustedfirmware.org: https://developer.trustedfirmware.org 136.. _review.trustedfirmware.org: https://review.trustedfirmware.org 137.. _issue: https://developer.trustedfirmware.org/project/board/1/ 138.. _Trusted Firmware-A: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git 139.. _Git guidelines: http://git-scm.com/book/ch5-2.html 140.. _Gerrit Uploading Changes documentation: https://review.trustedfirmware.org/Documentation/user-upload.html 141.. _Gerrit Signed-off-by Lines guidelines: https://review.trustedfirmware.org/Documentation/user-signedoffby.html 142.. _Gerrit Change-Ids documentation: https://review.trustedfirmware.org/Documentation/user-changeid.html 143.. _TF-A Tests: https://trustedfirmware-a-tests.readthedocs.io 144.. _Trusted Firmware binary repository: https://review.trustedfirmware.org/admin/repos/tf-binaries 145.. _tf-binaries-readme: https://git.trustedfirmware.org/tf-binaries.git/tree/readme.rst 146.. _TF-A mailing list: https://lists.trustedfirmware.org/mailman/listinfo/tf-a 147