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