|
4 | 4 | SPDX-License-Identifier: CC-BY-SA-4.0 |
5 | 5 | --> |
6 | 6 |
|
7 | | -Contributions to the seL4 kernel repository are welcome! |
8 | | - |
9 | | - |
10 | | -## CLA |
11 | | - |
12 | | -Please note that GD and Data61 require a contributor license agreement (CLA) |
13 | | -to be signed for all external contributions. Please see |
14 | | -[1] for details (it is a fairly short |
15 | | -and standard CLA). |
16 | | - |
17 | | -For the `seL4/seL4` repository, we can review pull requests directly on |
18 | | -github if we have a signed CLA on file. |
19 | | - |
20 | | -If you have only small trivial changes such as style, typos, comments, or |
21 | | -white space and don't want to sign a CLA for that, please file an issue in |
22 | | -the github issue tracker, we'll usually be happy to do the change ourselves |
23 | | -and attribute your idea by linking to the github issue in the change set |
24 | | -comment. |
| 7 | +# Contributions Welcome! |
25 | 8 |
|
| 9 | +Contributions to the seL4 kernel repository are welcome! |
26 | 10 |
|
27 | 11 | ## Kernel Development Process |
28 | 12 |
|
29 | | -In addition to our guidelines[1], the kernel has additional history requirements: |
| 13 | +In addition to our general [contribution guidelines][1], the kernel has additional git history requirements: |
30 | 14 |
|
31 | 15 | * Please try to make sure every commit is in a working state to facilitate bisecting. |
32 | 16 | + unless there is a concrete reason, if so please state that reason in the commit message. |
33 | 17 | * Try to keep commits small for ease of reviewing. |
34 | 18 |
|
| 19 | +[1]: https://docs.sel4.systems/Contributing |
| 20 | + |
35 | 21 | ## Build/Test |
36 | 22 |
|
37 | 23 | Generally, any contributions should pass the tests in the project |
38 | | -https://github.com/seL4/sel4test. If new features or platforms are added, |
| 24 | +<https://github.com/seL4/sel4test>. If new features or platforms are added, |
39 | 25 | they should add corresponding tests in `sel4test`. |
40 | 26 |
|
41 | | -Contributions to `master` should additionally either be invisible to the |
42 | | -proof in https://github.com/seL4/l4v, such as comments, documentation, style, |
| 27 | +Contributions to `master` should additionally either be invisible to the proof |
| 28 | +in <https://github.com/seL4/l4v>, such as comments, documentation, style, |
43 | 29 | unverified platform, etc, or they should come with proof updates to `l4v`. |
44 | 30 |
|
45 | | - |
46 | 31 | ## Contact |
47 | 32 |
|
48 | | -If you have larger changes or additions, it might be a good idea to get in |
49 | | -contact with us as <[email protected]>, so we can help you get started. |
| 33 | +If you have larger changes or additions, it is a good idea to get in contact |
| 34 | +with us as <[email protected]>, so we can help you get started. |
| 35 | + |
| 36 | +## Developer Certificate of Origin (DCO) |
| 37 | + |
| 38 | +This repository uses the same sign-off process as the Linux kernel. For every |
| 39 | +commit, use |
| 40 | + |
| 41 | + git commit -s |
| 42 | + |
| 43 | +to add a sign-off line to your commit message, which will come out as: |
| 44 | + |
| 45 | + Signed-off-by: name <email> |
| 46 | + |
| 47 | +By adding this line, you make the declaration that you have the right to make |
| 48 | +this contribution under the open source license the files use that you changed |
| 49 | +or contributed. |
50 | 50 |
|
51 | | -[1] https://docs.sel4.systems/Contributing |
| 51 | +The full text of the declaration is at <https://developercertificate.org>. |
0 commit comments