From patchwork Thu Jun 28 19:48:39 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Verma, Vishal L" X-Patchwork-Id: 10494999 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 6C71860325 for ; Thu, 28 Jun 2018 19:48:59 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 63A6E2A1A1 for ; Thu, 28 Jun 2018 19:48:59 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 559582A679; Thu, 28 Jun 2018 19:48:59 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.9 required=2.0 tests=BAYES_00, MAILING_LIST_MULTI, RCVD_IN_DNSWL_NONE autolearn=ham version=3.3.1 Received: from ml01.01.org (ml01.01.org [198.145.21.10]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id EB3692A1A1 for ; Thu, 28 Jun 2018 19:48:58 +0000 (UTC) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id 77DA1202E545F; Thu, 28 Jun 2018 12:48:58 -0700 (PDT) X-Original-To: linux-nvdimm@lists.01.org Delivered-To: linux-nvdimm@lists.01.org Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=134.134.136.126; helo=mga18.intel.com; envelope-from=vishal.l.verma@intel.com; receiver=linux-nvdimm@lists.01.org Received: from mga18.intel.com (mga18.intel.com [134.134.136.126]) (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 38D68211F8895 for ; Thu, 28 Jun 2018 12:48:56 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga004.fm.intel.com ([10.253.24.48]) by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 28 Jun 2018 12:48:56 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.51,284,1526367600"; d="scan'208";a="67187111" Received: from vverma7-desk1.lm.intel.com ([10.232.112.133]) by fmsmga004.fm.intel.com with ESMTP; 28 Jun 2018 12:48:56 -0700 From: Vishal Verma To: Subject: [ndctl PATCH v2] ndctl: Add CONTRIBUTING.md Date: Thu, 28 Jun 2018 13:48:39 -0600 Message-Id: <20180628194839.18791-1-vishal.l.verma@intel.com> X-Mailer: git-send-email 2.14.4 X-BeenThere: linux-nvdimm@lists.01.org X-Mailman-Version: 2.1.26 Precedence: list List-Id: "Linux-nvdimm developer list." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Yasunori Goto MIME-Version: 1.0 Errors-To: linux-nvdimm-bounces@lists.01.org Sender: "Linux-nvdimm" X-Virus-Scanned: ClamAV using ClamSMTP 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 Reviewed-by: Dan Williams Signed-off-by: Vishal Verma Reviewed-by: Yasunori Goto --- CONTRIBUTING.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..811a8c0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,48 @@ +# Contributing to ndctl + +Thank you 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 everything. It is recommended to send patches to + **```linux-nvdimm@lists.01.org```** + +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-style.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 mainly for smaller, more obvious fixups, + 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. + Larger changes may need to be sent to the mailing list so that everyone gets + an opportunity to review them. + +1. **Misc Best Practices:** + 1. Use a subject prefix of "ndctl PATCH" (or "ndctl PATCH vN" for a new + revision). This can be automated for a ```git format-patch``` command + by setting a repo-local git config setting: + ```git config format.subjectprefix "ndctl PATCH"``` + + 1. For commit messages: Describe the change and why it was needed. Use a + concise subject line, and a blank line between the subject and the body, + as well as between paragraphs. Use present tense and the imperative mood + (e.g. "Add support for.." instead of "Added support.." or "Adding + support"). Word-wrap to 72 columns.