Skip to content

Commit 952eeda

Browse files
committed
Add DCO information to Contribution Guidelines
Signed-off-by: Ben Engel <[email protected]>
1 parent c854a46 commit 952eeda

File tree

1 file changed

+60
-2
lines changed

1 file changed

+60
-2
lines changed

doc/howtocontribute.rst

Lines changed: 60 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,65 @@ Introduction
77
------------
88

99
The purpose of this document is to help contributors get started with
10-
the Open Simulation Interface (OSI) codebase.
10+
the ASAM Open Simulation Interface (OSI) codebase.
11+
12+
As an open-source standardisation project, we welcome and encourage the community to submit patches directly to the project. In our collaborative open source environment, standards and methods for submitting changes help reduce the chaos that can result from an active development community.
13+
14+
This document explains how to participate in project conversations, log bugs and enhancement requests, and submit patches to the project so your patch will be accepted quickly in the codebase.
15+
16+
Licensing
17+
---------
18+
19+
OSI uses the Mozilla Public License, v. 2.0. (as found in the LICENSE file in the project’s GitHub repo).
20+
21+
The license tells you what rights you have as a developer, provided by the copyright holder. It is important that the contributor fully understands the licensing rights and agrees to them. Sometimes the copyright holder isn’t the contributor, such as when the contributor is doing work on behalf of a company.
22+
23+
Developer Certification of Origin (DCO)
24+
---------------------------------------
25+
26+
To make a good faith effort to ensure licensing criteria are met, the OSI project requires the Developer Certificate of Origin (DCO) process to be followed.
27+
28+
The DCO is an attestation attached to every contribution made by every developer. In the commit message of the contribution, (described more fully later in this document), the developer simply adds a Signed-off-by statement and thereby agrees to the DCO.
29+
30+
When a developer submits a patch, it is a commitment that the contributor has the right to submit the patch per the license. The DCO agreement is shown below and `online <http://developercertificate.org/>`_.
31+
::
32+
33+
Developer's Certificate of Origin 1.1
34+
35+
By making a contribution to this project, I certify that:
36+
37+
(a) The contribution was created in whole or in part by me and I
38+
have the right to submit it under the open source license
39+
indicated in the file; or
40+
41+
(b) The contribution is based upon previous work that, to the
42+
best of my knowledge, is covered under an appropriate open
43+
source license and I have the right under that license to
44+
submit that work with modifications, whether created in whole
45+
or in part by me, under the same open source license (unless
46+
I am permitted to submit under a different license), as
47+
Indicated in the file; or
48+
49+
(c) The contribution was provided directly to me by some other
50+
person who certified (a), (b) or (c) and I have not modified
51+
it.
52+
53+
(d) I understand and agree that this project and the contribution
54+
are public and that a record of the contribution (including
55+
all personal information I submit with it, including my
56+
sign-off) is maintained indefinitely and may be redistributed
57+
consistent with this project or the open source license(s)
58+
involved.
59+
60+
DCO Sign-Off Methods
61+
--------------------
62+
63+
The DCO requires a sign-off message in the following format appear on each commit in the pull request:
64+
::
65+
66+
Signed-off-by: Firstname Lastname <[email protected]>
67+
68+
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.
1169

1270

1371
Reporting issues
@@ -69,7 +127,7 @@ the commits are combined
69127
into one commit and merged into the master branch.
70128
Once a pull request is ready, it is reviewed and
71129
approved, then squashed using the ``--fast-forward`` option of Git in order to
72-
maintain a streamlined Git history.
130+
maintain a streamlined Git history. Pull requests without a Sign-Off message (see DCO above) will not be accepted.
73131

74132
**We also enforce a few hygiene rules**:
75133

0 commit comments

Comments
 (0)