Submission Policy.md 2.71 KB
Newer Older
Nigel Kukard's avatar
Nigel Kukard committed
1 2 3
Submission Policy
==============

Nigel Kukard's avatar
Nigel Kukard committed
4
In order to submit code and for there to be a chance these submissions are included upstream there are a few policies which need to be adhered to.
Nigel Kukard's avatar
Nigel Kukard committed
5 6

## 1. Signed-Off
Nigel Kukard's avatar
Nigel Kukard committed
7

Nigel Kukard's avatar
Nigel Kukard committed
8
1.1. All commits must include a "Signed-Off: Name Surname <Email>" tag, adding this tag signifies that...
Nigel Kukard's avatar
Nigel Kukard committed
9 10

```text
Nigel Kukard's avatar
Nigel Kukard committed
11
Developer's Certificate of Origin 1.1
Nigel Kukard's avatar
Nigel Kukard committed
12 13 14

By making a contribution to this project, I certify that:

Nigel Kukard's avatar
Nigel Kukard committed
15
(a) The contribution was created in whole or in part by me and I have the right
Nigel Kukard's avatar
Nigel Kukard committed
16
    to submit it under the open source license indicated in the file; or
Nigel Kukard's avatar
Nigel Kukard committed
17

Nigel Kukard's avatar
Nigel Kukard committed
18
(b) The contribution is based upon previous work that, to the best of my
Nigel Kukard's avatar
Nigel Kukard committed
19 20 21 22 23
    knowledge, is covered under an appropriate open source license and I have
    the right under that license to submit that work with modifications, whether
    created in whole or in part by me, under the same open source license
    (unless I am permitted to submit under a different license), as indicated in
    the file; or
Nigel Kukard's avatar
Nigel Kukard committed
24 25

(c) The contribution was provided directly to me by some other person who
Nigel Kukard's avatar
Nigel Kukard committed
26
    certified (a), (b) or (c) and I have not modified it.
Nigel Kukard's avatar
Nigel Kukard committed
27

Nigel Kukard's avatar
Nigel Kukard committed
28
(d) I understand and agree that this project and the contribution are public and
Nigel Kukard's avatar
Nigel Kukard committed
29 30 31 32
    that a record of the contribution (including all personal information I
    submit with it, including my sign-off) is maintained indefinitely and may be
    redistributed consistent with this project or the open source license(s)
    involved.
Nigel Kukard's avatar
Nigel Kukard committed
33 34
```

Nigel Kukard's avatar
Nigel Kukard committed
35
The text of the DCO is located in the file [Documentation/SubmittingPatches](http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob;f=Documentation/SubmittingPatches) in the Linux kernel source tree.
Nigel Kukard's avatar
Nigel Kukard committed
36

Nigel Kukard's avatar
Nigel Kukard committed
37
## 2. License
Nigel Kukard's avatar
Nigel Kukard committed
38

Nigel Kukard's avatar
Nigel Kukard committed
39
2.1. All files must contain the relevant license block at the top with a file description line (see other files for the block to use), example...
Nigel Kukard's avatar
Nigel Kukard committed
40 41

```text
Nigel Kukard's avatar
Nigel Kukard committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
# AWIT CPM - AllWorldIT Credit Processing Module
# Copyright (c) 2013, AllWorldIT
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
```

Nigel Kukard's avatar
Nigel Kukard committed
59
## 3. Tabs/Spaces
Nigel Kukard's avatar
Nigel Kukard committed
60 61

3.1. All files must be tab indented unless the language prohibits this
Nigel Kukard's avatar
Nigel Kukard committed
62

Nigel Kukard's avatar
Nigel Kukard committed
63 64
3.2. No whitespaces at the end of the line are permitted

Nigel Kukard's avatar
Nigel Kukard committed
65
## 4. Line Endings
Nigel Kukard's avatar
Nigel Kukard committed
66

67
4.1. All line endings must be UNIX (\n) not DOS (\r\n) format