1<!--
2  Copyright 2017, Data61
3  Commonwealth Scientific and Industrial Research Organisation (CSIRO)
4  ABN 41 687 119 230.
5
6  This software may be distributed and modified according to the terms of
7  the GNU General Public License version 2. Note that NO WARRANTY is provided.
8  See "LICENSE_GPLv2.txt" for details.
9
10  @TAG(DATA61_GPL)
11-->
12
13Contributions to the seL4 kernel repository are welcome!
14
15
16## CLA
17
18Please note that GD and Data61 require a contributor license agreement (CLA)
19to be signed for all external contributions. Please see
20[1] for details (it is a fairly short
21and standard CLA).
22
23For the `seL4/seL4` repository, we can review pull requests directly on
24github if we have a signed CLA on file.
25
26If you have only small trivial changes such as style, typos, comments, or
27white space and don't want to sign a CLA for that, please file an issue in
28the github issue tracker, we'll usually be happy to do the change ourselves
29and attribute your idea by linking to the github issue in the change set
30comment.
31
32
33## Kernel Development Process
34
35In addition to our guidelines[1], the kernel has additional history requirements:
36
37* Please try to make sure every commit is in a working state to facilitate bisecting.
38    + unless there is a concrete reason, if so please state that reason in the commit message.
39* Try to keep commits small for ease of reviewing.
40
41## Build/Test
42
43Generally, any contributions should pass the tests in the project
44https://github.com/seL4/sel4test. If new features or platforms are added,
45they should add corresponding tests in `sel4test`.
46
47Contributions to `master` should additionally either be invisible to the
48proof in https://github.com/seL4/l4v, such as comments, documentation, style,
49unverified platform, etc, or they should come with proof updates to `l4v`.
50
51
52## Contact
53
54If you have larger changes or additions, it might be a good idea to get in
55contact with us as <devel@sel4.systems>, so we can help you get started.
56
57[1] https://docs.sel4.systems/Contributing
58