Skip to content

Commit 2b230ab

Browse files
Gerwin KleinGerwin Klein
authored andcommitted
update contribution guidelines
* the seL4 foundation requires DCO process instead of a CLA * minor document re-org and markdown lint fixes Signed-off-by: Gerwin Klein <[email protected]>
1 parent b6366c8 commit 2b230ab

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,48 +4,48 @@
44
SPDX-License-Identifier: CC-BY-SA-4.0
55
-->
66

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!
258

9+
Contributions to the seL4 kernel repository are welcome!
2610

2711
## Kernel Development Process
2812

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:
3014

3115
* Please try to make sure every commit is in a working state to facilitate bisecting.
3216
+ unless there is a concrete reason, if so please state that reason in the commit message.
3317
* Try to keep commits small for ease of reviewing.
3418

19+
[1]: https://docs.sel4.systems/Contributing
20+
3521
## Build/Test
3622

3723
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,
3925
they should add corresponding tests in `sel4test`.
4026

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,
4329
unverified platform, etc, or they should come with proof updates to `l4v`.
4430

45-
4631
## Contact
4732

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.
5050

51-
[1] https://docs.sel4.systems/Contributing
51+
The full text of the declaration is at <https://developercertificate.org>.

0 commit comments

Comments
 (0)