Skip to content

Commit 479772c

Browse files
committed
docs: Add a CONTRIBUTING document
Add an initial document detailing best practices for contributing to the document. Add the "developer certificate of origin" document. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
1 parent 1d276d1 commit 479772c

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

docs/CONTRIBUTING.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing to Klipper
2+
3+
Thank you for contributing to Klipper! Please take a moment to read
4+
this document.
5+
6+
## Creating a new issue
7+
8+
Please see the [contact page](Contact.md) for information on creating
9+
an issue. In particular, **we need the klippy.log file** attached to
10+
bug reports. Also, be sure to read the [FAQ](FAQ.md) to see if a
11+
similar issue has already been raised.
12+
13+
## Submitting a pull request
14+
15+
Contributions of Code and documentation are managed through github
16+
pull requests. Each commit should have a commit message formatted
17+
similar to the following:
18+
19+
```
20+
module: Capitalized, short (50 chars or less) summary
21+
22+
More detailed explanatory text, if necessary. Wrap it to about 75
23+
characters or so. In some contexts, the first line is treated as the
24+
subject of an email and the rest of the text as the body. The blank
25+
line separating the summary from the body is critical (unless you omit
26+
the body entirely); tools like rebase can get confused if you run the
27+
two together.
28+
29+
Further paragraphs come after blank lines..
30+
31+
Signed-off-by: My Name <myemail@example.org>
32+
```
33+
34+
It is important to have a "Signed-off-by" line on each commit - it
35+
certifies that you agree to the
36+
[developer certificate of origin](developer-certificate-of-origin). It
37+
must contain your real name (sorry, no pseudonyms or anonymous
38+
contributions) and contain a current email address.

docs/developer-certificate-of-origin

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Developer Certificate of Origin
2+
Version 1.1
3+
4+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
5+
1 Letterman Drive
6+
Suite D4700
7+
San Francisco, CA, 94129
8+
9+
Everyone is permitted to copy and distribute verbatim copies of this
10+
license document, but changing it is not allowed.
11+
12+
13+
Developer's Certificate of Origin 1.1
14+
15+
By making a contribution to this project, I certify that:
16+
17+
(a) The contribution was created in whole or in part by me and I
18+
have the right to submit it under the open source license
19+
indicated in the file; or
20+
21+
(b) The contribution is based upon previous work that, to the best
22+
of my knowledge, is covered under an appropriate open source
23+
license and I have the right under that license to submit that
24+
work with modifications, whether created in whole or in part
25+
by me, under the same open source license (unless I am
26+
permitted to submit under a different license), as indicated
27+
in the file; or
28+
29+
(c) The contribution was provided directly to me by some other
30+
person who certified (a), (b) or (c) and I have not modified
31+
it.
32+
33+
(d) I understand and agree that this project and the contribution
34+
are public and that a record of the contribution (including all
35+
personal information I submit with it, including my sign-off) is
36+
maintained indefinitely and may be redistributed consistent with
37+
this project or the open source license(s) involved.

0 commit comments

Comments
 (0)