From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id D92412934 for ; Sat, 10 Dec 2016 06:05:05 +0100 (CET) Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga101.jf.intel.com with ESMTP; 09 Dec 2016 21:05:04 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.33,326,1477983600"; d="scan'208";a="41070606" Received: from sivswdev02.ir.intel.com ([10.237.217.46]) by fmsmga006.fm.intel.com with ESMTP; 09 Dec 2016 21:05:03 -0800 From: Ferruh Yigit To: spp@dpdk.org Date: Sat, 10 Dec 2016 05:05:01 +0000 Message-Id: <20161210050501.19071-1-ferruh.yigit@intel.com> X-Mailer: git-send-email 2.8.4 Subject: [spp] [PATCH] doc: add contribution guide X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 10 Dec 2016 05:05:06 -0000 Signed-off-by: Ferruh Yigit --- CONTRIBUTING.txt | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 CONTRIBUTING.txt 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 -- 2.9.3