@@ -14,11 +14,21 @@ Other formatting requirements:
1414- 4 space indents, no tabs are allowed.
1515- No trailing whitespace.
1616- All source files must end with a newline (an empty line at the end).
17- - Lines should generally not be longer than 120 characters, though this is not a hard rule.
17+ - Lines should generally not be longer than 120 characters, though this is not a hard rule. Overall readability
18+ is more important.
1819
1920
2021## Process
2122
23+ Before you submit your changes, please ensure that:
24+
25+ - The code meets style requirements listed above.
26+ - You have added your copyright below existing copyrights in the files you modified. New files should have only
27+ your copyright. See the License section below for more.
28+ - Changes have been tested locally to the extent possible. (Obviously, we don't expect you to have as many
29+ test boards as we do.)
30+ - Your code works with both Python 2 and Python 3.
31+
2232Please create a pull request in GitHub with your contribution. Before creating the pull request,
2333please ensure that all tests pass. We also run the tests on a wide range of boards for every pull
2434request using our CI setup. Changes must pass on all tested boards before the the pull request can
@@ -29,8 +39,19 @@ environment. The [automated tests guide](docs/automated_tests.md) provides infor
2939available types of tests and describes how to run the tests.
3040
3141
32- ## More
42+ ## License
43+
44+ By creating a pull request on GitHub, you are granting license your contributions under the same Apache 2.0
45+ license as the original code. However, the copyright on contributions is retained by their author(s). Please
46+ add your copyright below existing copyrights in the license header at the top of the source file. If you are
47+ doing the work for your employer, you should use your employer's copyright. If a file is newly added by you,
48+ it must contain the standard license header with your copyright. Please note that we do not list changes in
49+ each source file by copyright owner, as this becomes a burden to maintain.
50+
51+ Contributing source code that is already licensed using a license other than Apache 2.0 is possible, but each
52+ case must be considered individually. (If you are the owner of the source code, then you have the right to
53+ relicense to Apache 2.0.) The most important thing is that the license is compatible with Apache 2.0. Examples
54+ are MIT, the BSD licenses, and similar. GPL-licensed code is expressly disallowed to be contributed, as the
55+ GPL is not compatible with Apache 2.0 (or any of the Apache-compatible licenses).
56+
3357
34- For more information about contributing, see the Mbed OS [ contributor
35- documentation] ( http://os.mbed.com/contributing ) . Although this documentation is written primarily
36- with Mbed OS in mind, much of it applies directly to pyOCD, as well.
0 commit comments