diff mbox

[03/23] Add reporting bugs and submitting patches sections to README.md

Message ID 1474495729-17604-4-git-send-email-jgunthorpe@obsidianresearch.com (mailing list archive)
State Accepted
Headers show

Commit Message

Jason Gunthorpe Sept. 21, 2016, 10:08 p.m. UTC 
From: Christoph Hellwig <hch@lst.de>

Based on the wording from the libibverbs and srp_daemon README files.

Signed-off-by: Christoph Hellwig <hch@lst.de>
---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
diff mbox

Patch

diff --git a/README.md b/README.md
index 65c7644ad770..8c31944c91a8 100644
--- a/README.md
+++ b/README.md
@@ -95,3 +95,31 @@  $ install -m755 ninja /usr/local/bin/ninja
 ```
 
 Use the 'cmake3' program in place of `cmake` in the above instructions.
+
+# Reporting bugs
+
+Bugs should be reported to the <linux-rdma@vger.kernel.org> mailing list
+In your bug report, please include:
+
+ * Information about your system:
+   - Linux distribution and version
+   - Linux kernel and version
+   - InfiniBand hardware and firmware version
+   - ... any other relevant information
+
+ * How to reproduce the bug.
+
+ * If the bug is a crash, the exact output printed out when the crash
+   occurred, including any kernel messages produced.
+
+# Submitting patches
+
+Patches should also be submitted to the <linux-rdma@vger.kernel.org>
+mailing list.  Please use unified diff form (the -u option to GNU diff),
+and include a good description of what your patch does and why it should
+be applied.  If your patch fixes a bug, please make sure to describe the
+bug and how your fix works.
+
+Make sure that your contribution can be licensed under the same
+license as the original code you are patching, and that you have all
+necessary permissions to release your work.