summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFerruh Yigit <ferruh.yigit@intel.com>2016-12-10 05:01:10 +0000
committerFerruh Yigit <ferruh.yigit@intel.com>2017-05-16 11:56:24 +0100
commit0bad67606017f083b04bc2bae241ac605cd41e74 (patch)
treeec9ad85a21c0ec017ecb30ff247f7e234b932d33
parent8753e014c0b9b2ea0cb03e177272f334126cd791 (diff)
downloadspp-0bad67606017f083b04bc2bae241ac605cd41e74.zip
spp-0bad67606017f083b04bc2bae241ac605cd41e74.tar.gz
spp-0bad67606017f083b04bc2bae241ac605cd41e74.tar.xz
doc: add contribution guide
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
-rw-r--r--CONTRIBUTING.txt51
1 files changed, 51 insertions, 0 deletions
diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt
new file mode 100644
index 0000000..01e1b65
--- /dev/null
+++ b/CONTRIBUTING.txt
@@ -0,0 +1,51 @@
+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
+----------
+
+The SPP maintainer is: Ferruh Yigit <ferruh.yigit@intel.com>