1 Contributing to Project Ne10
2 ====================================
4 Before you start contributing to this project you must sign the ARM
5 Contributor License Agreement (CLA).
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
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.
19 ARM reserves the right to not accept a contribution. This may be for technical,
20 commercial or legal reasons.
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
31 * If you intend to include Third Party IP in your contribution, please
32 raise a separate [issue] for this and ensure that the changes that
33 include Third Party IP are made on a separate topic branch.
34 * [Fork][] [Ne10][] on GitHub.
35 * Clone the fork to your own machine.
36 * Create a local topic branch based on the [Ne10][] `master`
43 * Make commits of logical units. See these general [Git guidelines] for
44 contributing to a project.
45 * Follow the [ProjectNe10 coding style]; this style is enforced for ProjectNe10.
46 * Keep the commits on topic. If you need to fix another bug or make another
47 enhancement, please create a separate [issue] and address it on a separate
49 * Avoid long commit series. If you do have a long series, consider whether
50 some commits should be squashed together or addressed in a separate topic.
51 * Make sure your commit messages are in the proper format. If a commit fixes
52 a GitHub [issue], include a reference (e.g.
53 "fixes projectNe10/Ne10/issues/54"); this ensures the [issue] is
54 [automatically closed] when merged into the [Ne10] `master`
56 * Where appropriate, please update the documentation.
57 * Consider whether the [Release Notes] or [Building] file in the
58 [Documentation] folder need updating.
59 * Changes that have a material impact on behavior or programming
60 interfaces should have an entry at the end of the [Release Notes]. Minor
61 changes (e.g. basic refactoring or typo fixes) do not need an entry.
62 * If this is your first contribution, you may add your name or your
63 company name to the [Acknowledgements] 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 * Please test your changes. As a minimum, ensure the test application builds and runs.
68 Also, perform unit and conformance tests on new functions.
74 * Ensure we have your signed CLA.
75 * Push your local changes to your fork of the repository.
76 * Submit a [pull request] to Ne10.
77 * The changes in the pull request will then undergo further review and
78 testing. Any review comments will be made as comments on the [pull
79 request]. This may require you to do some rework.
80 * When the changes are accepted, ARM will integrate them.
81 * To ensure a linear commit history, ARM will typically rebase the commits
82 locally before merging to the [Ne10] `master` branch. In
83 this case, the [pull request] will be closed rather than directly merged
84 on GitHub. If the rebase is not trivial, you may be asked to rebase the
88 - - - - - - - - - - - - - - - - - - - - - - - - - -
90 _Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved._
93 [Release Notes]: ./doc/ReleaseNote.txt
94 [Building]: ./doc/BuildingNe10.txt
95 [Documentation]: http://projectne10.github.io/Ne10/doc/
96 [Acknowledgements]: ./doc/acknowledgements.md "Contributor acknowledgements"
98 [GitHub account]: https://github.com/signup/free
99 [Fork]: https://help.github.com/articles/fork-a-repo
100 [issue]: https://github.com/projectNe10/Ne10/issues
101 [pull request]: https://help.github.com/articles/using-pull-requests
102 [automatically closed]: https://help.github.com/articles/closing-issues-via-commit-messages
103 [Git guidelines]: http://git-scm.com/book/ch5-2.html
104 [ProjectNe10 coding style]: https://github.com/projectNe10/Ne10/wiki/CodeStyleGuide
105 [Ne10]: https://github.com/projectNe10/Ne10
106 [contributing page]: http://www.arm.com/community/open-source-contributing.php