From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 146AE202E5458 for ; Thu, 28 Jun 2018 09:48:23 -0700 (PDT) From: "Verma, Vishal L" Subject: Re: [ndctl PATCH] ndctl: Add CONTRIBUTING.md Date: Thu, 28 Jun 2018 16:48:21 +0000 Message-ID: <1530204500.7574.1.camel@intel.com> References: <20180627231905.771-1-vishal.l.verma@intel.com> <20180628101112.B4C2.E1E9C6FF@jp.fujitsu.com> In-Reply-To: <20180628101112.B4C2.E1E9C6FF@jp.fujitsu.com> Content-Language: en-US Content-ID: <880446EA8E44774896B8851347801A76@intel.com> MIME-Version: 1.0 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: linux-nvdimm-bounces@lists.01.org Sender: "Linux-nvdimm" To: "y-goto@jp.fujitsu.com" Cc: "linux-nvdimm@lists.01.org" List-ID: On Thu, 2018-06-28 at 10:11 +0900, Yasunori Goto wrote: > Hi, Vishal-san, > > > We were missing a CONTRIBUTING file to help new contributors follow > > the > > expected guidelines. Add one that refers to the Linux Kernel for > > most of > > these things, such as Coding style, Submitting Patches, and the > > DCO. > > > > Cc: Dan Williams > > Signed-off-by: Vishal Verma > > --- > > CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++ > > 1 file changed, 31 insertions(+) > > create mode 100644 CONTRIBUTING.md > > > > diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md > > new file mode 100644 > > index 0000000..aa9e78d > > --- /dev/null > > +++ b/CONTRIBUTING.md > > @@ -0,0 +1,31 @@ > > +# Contributing to ndctl > > + > > +Thanks for taking the time to contribute to ndctl. > > + > > +The following is a set of guidelines that we adhere to, and > > request that > > +contributors follow. > > + > > +1. The libnvdimm (kernel subsystem) and ndctl developers primarily > > use > > + the [linux-nvdimm](https://lists.01.org/mailman/listinfo/linux- > > nvdimm) > > + mailing list for discussions as well as posting patches. > > +1. Github [issues](https://github.com/pmem/ndctl/issues) are an > > acceptable > > + way to report a problem, but if you just have a question, > > + [email](mailto:linux-nvdimm@lists.01.org) the above list. > > +1. We follow the Linux Kernel [Coding Style Guide][cs] as > > applicable. > > + > > + [cs]: https://www.kernel.org/doc/html/latest/process/coding-sty > > le.html > > + > > +1. We follow the Linux Kernel [Submitting Patches Guide][sp] as > > applicable. > > + > > + [sp]: https://www.kernel.org/doc/html/latest/process/submitting > > -patches.html > > + > > +1. We follow the Linux Kernel [DCO][dco] (Developer Certificate of > > Origin). > > + The DCO is an attestation attached to every contribution made > > by every > > + developer. In the commit message of the contribution, the > > developer simply > > + adds a Signed-off-by statement and thereby agrees to the DCO. > > + > > + [dco]: https://developercertificate.org/ > > + > > +1. Github Pull Requests are acceptable, but won't be merged > > directly, as > > + Github doesn't allow for the kernel style flow of patches where > > a maintainer > > + also signs off on the patches they apply. > > In my impression, newbie may not catch where is the mailing list > for sending patch from this description, and may not understand > what is difference between "[ndctl PATCH]" and > "[PATCH] pmem/libnvdimm/dax or others". > > So, I think the followings descriptions are necessary. > > - specify that linux-nvdimm@lists.01.org is suitable for sending > patch. > - Which is better to use [ndctl PATCH] or [PATCH] xxxx: at subject. Goto-san, These are good points. I'll update to spell out an actual email address instead of a slightly hidden mailto: link. And I'll add a few best- practices notes such as the "ndctl PATCH" bit. Thanks for the feedback! -Vishal > > Thanks, > > > > _______________________________________________ Linux-nvdimm mailing list Linux-nvdimm@lists.01.org https://lists.01.org/mailman/listinfo/linux-nvdimm