1 Contributing to ARM Trusted Firmware 2 ==================================== 3 4 Before you start contributing to this project you must sign the ARM 5 Contributor License Agreement (CLA). 6 7 Individuals who want to contribute their own work must sign and return an 8 Individual CLA. Companies that want to contribute must sign and return a 9 Corporate CLA if their employees' intellectual property has been assigned to 10 the employer. Copies of the CLAs are available from the [contributing page] of 11 the ARM website. 12 13 For this project, ARM also requires the GitHub account name(s) associated with 14 each individual contributor or the designated employees of corporate 15 contributors. Only contributions originating from these accounts will be 16 considered covered by the CLA. To avoid delay, you should provide the Github 17 account name(s) at the same time as the signed CLA. 18 19 ARM reserves the right to not accept a contribution. This may be for technical, 20 commercial or legal reasons. 21 22 23 Getting Started 24 --------------- 25 26 * Make sure you have a [GitHub account]. 27 * Create an [issue] for your work if one does not already exist. This gives 28 everyone visibility of whether others are working on something similar. ARM 29 licensees may contact ARM directly via their partner managers instead if 30 they prefer. 31 * Note that the [issue] tracker for this project is in a separate 32 [issue tracking repository]. Please follow the guidelines in that 33 repository. 34 * If you intend to include Third Party IP in your contribution, please 35 raise a separate [issue] for this and ensure that the changes that 36 include Third Party IP are made on a separate topic branch. 37 * [Fork][] [arm-trusted-firmware][] on GitHub. 38 * Clone the fork to your own machine. 39 * Create a local topic branch based on the [arm-trusted-firmware][] `master` 40 branch. 41 42 43 Making Changes 44 -------------- 45 46 * Make commits of logical units. See these general [Git guidelines] for 47 contributing to a project. 48 * Follow the [Linux coding style]; this style is enforced for the ARM Trusted 49 Firmware project (style errors only, not warnings). 50 * Use the checkpatch.pl script provided with the Linux source tree. A 51 Makefile target is provided for convenience (see section 2 in the 52 [User Guide]). 53 * Keep the commits on topic. If you need to fix another bug or make another 54 enhancement, please create a separate [issue] and address it on a separate 55 topic branch. 56 * Avoid long commit series. If you do have a long series, consider whether 57 some commits should be squashed together or addressed in a separate topic. 58 * Make sure your commit messages are in the proper format. If a commit fixes 59 a GitHub [issue], include a reference (e.g. 60 "fixes arm-software/tf-issues#45"); this ensures the [issue] is 61 [automatically closed] when merged into the [arm-trusted-firmware] `master` 62 branch. 63 * Where appropriate, please update the documentation. 64 * Consider whether the [User Guide], [Porting Guide], [Firmware Design] or 65 other in-source documentation needs updating. 66 * If this is your first contribution, you may add your name or your 67 company name to the [Acknowledgements] file. 68 * For topics with multiple commits, you should make all documentation 69 changes (and nothing else) in the last commit of the series. Otherwise, 70 include the documentation changes within the single commit. 71 * Please test your changes. As a minimum, ensure UEFI boots to the shell on 72 the Foundation FVP. See the "[Running the software]" section of the 73 [User Guide] for more information. 74 75 76 Submitting Changes 77 ------------------ 78 79 * Ensure we have your signed CLA. 80 * Push your local changes to your fork of the repository. 81 * Submit a [pull request] to the [arm-trusted-firmware] `integration` branch. 82 * The changes in the [pull request] will then undergo further review and 83 testing. Any review comments will be made as comments on the [pull 84 request]. This may require you to do some rework. 85 * When the changes are accepted, ARM will integrate them. 86 * Typically, ARM will merge the [pull request] into the `integration` 87 branch within the GitHub UI, creating a merge commit. 88 * Please avoid creating merge commits in the [pull request] itself. 89 * If the [pull request] is not based on a recent commit, ARM may rebase 90 it onto the `master` branch first, or ask you to do this. 91 * If the [pull request] cannot be automatically merged, ARM will ask you 92 to rebase it onto the `master` branch. 93 * After final integration testing, ARM will push your merge commit to the 94 `master` branch. If a problem is found at this stage, the merge commit 95 will be removed from the `integration` branch and ARM will ask you to 96 create a new pull request to resolve the problem. 97 * Please do not delete your topic branch until it is safely merged into 98 the `master` branch. 99 100 101 - - - - - - - - - - - - - - - - - - - - - - - - - - 102 103 _Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved._ 104 105 106 [User Guide]: ./docs/user-guide.md 107 [Running the software]: ./docs/user-guide.md#6--running-the-software 108 [Porting Guide]: ./docs/porting-guide.md 109 [Firmware Design]: ./docs/firmware-design.md 110 [Acknowledgements]: ./acknowledgements.md "Contributor acknowledgements" 111 112 [contributing page]: http://www.arm.com/community/open-source-contributing.php 113 [GitHub account]: https://github.com/signup/free 114 [Fork]: https://help.github.com/articles/fork-a-repo 115 [issue tracking repository]: https://github.com/ARM-software/tf-issues 116 [issue]: https://github.com/ARM-software/tf-issues/issues 117 [pull request]: https://help.github.com/articles/using-pull-requests 118 [automatically closed]: https://help.github.com/articles/closing-issues-via-commit-messages 119 [Git guidelines]: http://git-scm.com/book/ch5-2.html 120 [Linux coding style]: https://www.kernel.org/doc/Documentation/CodingStyle 121 [arm-trusted-firmware]: https://github.com/ARM-software/arm-trusted-firmware 122
