summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.txt
blob: 2467547c634fbdaff516d1ad32292435533ee5c4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
Contributors Guide
==================

This document outlines how to contribute code to the SPP project.

Getting the code
----------------

The SPP code can be cloned from the repository on dpdk.org as follows:

    git clone git://dpdk.org/apps/spp
    git clone http://dpdk.org/git/apps/spp

The code can be browsed at http://dpdk.org/browse/apps/spp/

Submitting Patches
------------------

Contributions to SPP should be submitted as git formatted patches to the
SPP mailing list: spp@dpdk.org

Note you must first register for the mailing list at:
http://dpdk.org/ml/listinfo/spp

The commit message must end with a "Signed-off-by:" line which is added using:

    git commit --signoff # or -s

The purpose of the signoff is explained in the Linux kernel guidelines
Developer's Certificate of Origin:
http://www.kernel.org/doc/Documentation/SubmittingPatches

Note:
    All developers must ensure that they have read, understood and complied
    with the Developer's Certificate of Origin section of the documentation
    prior to applying the signoff and submitting a patch.

The DPDK Code Contributors guidelines contain information that is
useful for submitting patches to SPP:
http://dpdk.org/doc/guides/contributing/index.html

Coding Guidelines
-----------------

* C code should follow the DPDK coding standards.
* Python code should follow PEP8.

Maintainer
----------

* Ferruh Yigit <ferruh.yigit@intel.com>
* Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>