Remove spaces as coding style in README.md #213

[etc/vim.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b29b8cc752ff828929801ea386f082b132355daf..a2c158087b5759bcdb1c039aa4b4d953676c08ca 100644 (file)
--- 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.
 # 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!
+```