Browse Source

CONTRIBUTING.md: add a section about issue reporting

Simon Ruggier 3 years ago
parent
commit
af5bd7c119
1 changed files with 15 additions and 0 deletions
  1. 15
    0
      CONTRIBUTING.md

+ 15
- 0
CONTRIBUTING.md View File

@@ -37,3 +37,18 @@ If you wish to have a behavior that differs from that style guide, add an option
37 37
 # Tests
38 38
 
39 39
 All new features must have unit tests.
40
+
41
+# Issues
42
+
43
+Issues are tracked within GitHub.
44
+
45
+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):
46
+
47
+```
48
+Minimal example:
49
+
50
+    ```
51
+    =
52
+    ```
53
+    bad!
54
+```

Loading…
Cancel
Save