Skip to content

Commit bbd08ae

Browse files
committed
Add contribution guidelines
Signed-off-by: Tobias Kasper <tobias.kasper@tngtech.com>
1 parent 81f55be commit bbd08ae

File tree

2 files changed

+97
-0
lines changed

2 files changed

+97
-0
lines changed

CONTRIBUTING.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Contributing
2+
3+
Contributions are very welcome. The following will provide some helpful guidelines.
4+
5+
## How to contribute
6+
7+
If you want to tackle an existing issue please add a comment to make sure the issue is sufficiently discussed
8+
and that no two contributors collide by working on the same issue.
9+
To submit a contribution, please follow the following workflow:
10+
11+
* Fork the project
12+
* Create a feature branch
13+
* Add your contribution
14+
* Create a Pull Request
15+
16+
### Commits
17+
18+
Commit messages should be clear and fully elaborate the context and the reason of a change.
19+
Each commit message should follow the following conventions:
20+
21+
* it may use markdown to improve readability on GitHub
22+
* it should start with a title
23+
* less than 70 characters
24+
* starting lowercase
25+
* if the commit is not trivial the title should be followed by a body
26+
* separated from the title by a blank line
27+
* explaining all necessary context and reasons for the change
28+
* if your commit refers to an issue, please post-fix it with the issue number, e.g. `#123` or `Resolves #123`
29+
30+
A full example:
31+
32+
```
33+
Fix calculation of menu state
34+
35+
Due to operator precedence, `$(( $menu_state ± 1 % 3 ))`
36+
was basically equivalent to `$(( $menu_state ± 1 ))`.
37+
38+
Also change 1-based `menu_state` to 0-based `selected_option_index`
39+
to be able to directly use modulo arithmetics.
40+
41+
Resolves #7
42+
```
43+
44+
Furthermore, commits must be signed off according to the [DCO](DCO).

DCO

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
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.
38+
39+
#### DCO Sign-Off Methods
40+
41+
The DCO requires a sign-off message in the following format appear on each commit in the pull request:
42+
43+
> Signed-off-by: Random J Developer <random@developer.example.org>
44+
45+
using your real name (sorry, no pseudonyms or anonymous contributions.)
46+
47+
The DCO text can either be manually added to your commit body, or you can add either **-s** or **--signoff** to your usual git commit commands. If you forget to add the sign-off you can also amend a previous commit with the sign-off by running **git commit --amend -s**. If you've pushed your changes to Github already you'll need to force push your branch after this with **git push -f**.
48+
49+
50+
#### Alternative Sign-Off Methods in rare cases
51+
52+
53+
If it is really no option for you to disclose your real name and email address, there might be a chance that you can get your contribution accepted. In this case please contact the maintainers directly and verify the adherence to the DCO of the contribution manually. This might include quite some legal overhead for both parties.

0 commit comments

Comments
 (0)