We were missing a CONTRIBUTING file to help new contributors follow
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 <dan.j.williams(a)intel.com>
Signed-off-by: Vishal Verma <vishal.l.verma(a)intel.com>
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
@@ -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
+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:firstname.lastname@example.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, 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(a)lists.01.org is suitable for sending patch.
- Which is better to use [ndctl PATCH] or [PATCH] xxxx: at subject.