From: Simon Ruggier <Simon80@gmail.com>
Date: Sun, 24 May 2015 21:37:22 +0000 (-0400)
Subject: CONTRIBUTING.md: add a section about issue reporting
X-Git-Url: https://git.madduck.net/etc/vim.git/commitdiff_plain/af5bd7c119e061838d483fb9903f456e09e73518?ds=inline

CONTRIBUTING.md: add a section about issue reporting
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b29b8cc..a2c1580 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -37,3 +37,18 @@ If you wish to have a behavior that differs from that style guide, add an option
 # Tests
 
 All new features must have unit tests.
+
+# Issues
+
+Issues are tracked within GitHub.
+
+When reporting issues, your report is more effective if you include a minimal example file that reproduces the problem. Try to trim out as much as possible, until you have the smallest possible file that still reproduces the issue. Paste the example inline into your issue report, quoted using four spaces at the beginning of each line, like this example from issue [#189](https://github.com/plasticboy/vim-markdown/issues/189):
+
+```
+Minimal example:
+
+    ```
+    =
+    ```
+    bad!
+```