Skip to content

Commit f8d2e14

Browse files
committed
CONTRIBUTING: add standard Rebble contributing guide
1 parent 3fda6f2 commit f8d2e14

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

CONTRIBUTING.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Contribution Guidelines
2+
3+
## Developer Certification of Origin (DCO)
4+
5+
To make a good faith effort to ensure licensing criteria are met, this
6+
project requires the Developer Certificate of Origin (DCO) process to be
7+
followed.
8+
9+
The DCO is an attestation attached to every contribution made by every
10+
developer. In the commit message of the contribution, (described more fully
11+
later in this document), the developer simply adds a `Signed-off-by`
12+
statement and thereby agrees to the DCO.
13+
14+
When a developer submits a patch, it is a commitment that the contributor has
15+
the right to submit the patch per the license. The DCO agreement is shown
16+
below and at http://developercertificate.org/.
17+
18+
```
19+
Developer's Certificate of Origin 1.1
20+
21+
By making a contribution to this project, I certify that:
22+
23+
(a) The contribution was created in whole or in part by me and I
24+
have the right to submit it under the open source license
25+
indicated in the file; or
26+
27+
(b) The contribution is based upon previous work that, to the best
28+
of my knowledge, is covered under an appropriate open source
29+
license and I have the right under that license to submit that
30+
work with modifications, whether created in whole or in part
31+
by me, under the same open source license (unless I am
32+
permitted to submit under a different license), as indicated
33+
in the file; or
34+
35+
(c) The contribution was provided directly to me by some other
36+
person who certified (a), (b) or (c) and I have not modified
37+
it.
38+
39+
(d) I understand and agree that this project and the contribution
40+
are public and that a record of the contribution (including all
41+
personal information I submit with it, including my sign-off) is
42+
maintained indefinitely and may be redistributed consistent with
43+
this project or the open source license(s) involved.
44+
```
45+
46+
### DCO Sign-Off
47+
48+
The "sign-off" in the DCO is a "Signed-off-by:" line in each commit's log
49+
message. The Signed-off-by: line must be in the following format:
50+
51+
```
52+
Signed-off-by: Your Name <[email protected]>
53+
```
54+
55+
For your commits, replace:
56+
57+
- `Your Name` with your real name (pseudonyms, hacker handles, and the
58+
names of groups are not allowed)
59+
60+
- `[email protected]` with the same email address you are using to
61+
author the commit (CI will fail if there is no match)
62+
63+
You can automatically add the Signed-off-by: line to your commit body using
64+
`git commit -s`. Use other commits in the repository as examples.
65+
66+
Additional requirements:
67+
68+
- If you are altering an existing commit created by someone else, you must add
69+
your Signed-off-by: line without removing the existing one.

0 commit comments

Comments
 (0)