summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..cde8527
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,24 @@
+# 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).
+(SPDX-License-Identifier: GPL-2.0-or-later)**
+
+Because there are a few files licensed under GPL-2.0-only, the whole
+project is tagged as GPL-2.0-only and not as GPL-2.0-or-later.
+
+### 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).