57 lines
2 KiB
Markdown
57 lines
2 KiB
Markdown
<!--
|
|
Copyright 2017, Data61
|
|
Commonwealth Scientific and Industrial Research Organisation (CSIRO)
|
|
ABN 41 687 119 230.
|
|
|
|
This software may be distributed and modified according to the terms of
|
|
the GNU General Public License version 2. Note that NO WARRANTY is provided.
|
|
See "LICENSE_GPLv2.txt" for details.
|
|
|
|
@TAG(DATA61_GPL)
|
|
-->
|
|
|
|
Contributions to the seL4 kernel repository are welcome!
|
|
|
|
|
|
## CLA
|
|
|
|
Please note that GD and Data61 require a contributor license agreement (CLA)
|
|
to be signed for all external contributions. Please see
|
|
[1] for details (it is a fairly short
|
|
and standard CLA).
|
|
|
|
For the `seL4/seL4` repository, we can review pull requests directly on
|
|
github if we have a signed CLA on file.
|
|
|
|
If you have only small trivial changes such as style, typos, comments, or
|
|
white space and don't want to sign a CLA for that, please file an issue in
|
|
the github issue tracker, we'll usually be happy to do the change ourselves
|
|
and attribute your idea by linking to the github issue in the change set
|
|
comment.
|
|
|
|
|
|
## Kernel Development Process
|
|
|
|
In addition to our guidelines[1], the kernel has additional history requirements:
|
|
|
|
* Please try to make sure every commit is in a working state to facilitate bisecting.
|
|
+ unless there is a concrete reason, if so please state that reason in the commit message.
|
|
* Try to keep commits small for ease of reviewing.
|
|
|
|
## Build/Test
|
|
|
|
Generally, any contributions should pass the tests in the project
|
|
https://github.com/seL4/sel4test. If new features or platforms are added,
|
|
they should add corresponding tests in `sel4test`.
|
|
|
|
Contributions to `master` should additionally either be invisible to the
|
|
proof in https://github.com/seL4/l4v, such as comments, documentation, style,
|
|
unverified platform, etc, or they should come with proof updates to `l4v`.
|
|
|
|
|
|
## Contact
|
|
|
|
If you have larger changes or additions, it might be a good idea to get in
|
|
contact with us as <devel@sel4.systems>, so we can help you get started.
|
|
|
|
[1] https://docs.sel4.systems/Contributing
|