]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
Add "CONTRIBUTING" file.
authorKeith Busch <keith.busch@intel.com>
Thu, 4 Feb 2016 17:48:07 +0000 (10:48 -0700)
committerKeith Busch <keith.busch@intel.com>
Thu, 4 Feb 2016 17:53:53 +0000 (10:53 -0700)
Setting general rules for contributing. Nothing is changing, but need
to make it explicit that contributions can't violate the software license.

Signed-off-by: Keith Busch <keith.busch@intel.com>
CONTRIBUTING.md [new file with mode: 0644]

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..3b7f55f
--- /dev/null
@@ -0,0 +1,20 @@
+# Contributing to the NVM-e CLI
+
+Here you will find instructions on how to contribute to the NVM-Express command
+line interface.
+
+Contributions and new ideas are most welcome!
+
+**NOTE: If you do decide to implement code changes and contribute them,
+please make sure you agree your contribution can be made available
+under the [GPLv2-style License used for the NVMe CLI](https://github.com/linux-nvme/nvme-cli/blob/master/LICENSE).**
+
+### Code Contributions
+
+Please feel free to use the github forums to ask for comments & questions on
+your code before submitting a pull request.  The NVMe CLI project uses the
+common *fork and merge* workflow used by most GitHub-hosted projects.
+
+### Bug Reports
+
+Bugs for the NVM Library project are tracked in our [GitHub Issues Database](https://github.com/linux-nvme/nvme-cli/issues).