Permalink
Browse files

CONTRIBUTING.md: add a section about issue reporting

  • Loading branch information...
1 parent e43bca7 commit af5bd7c119e061838d483fb9903f456e09e73518 Simon Ruggier committed May 24, 2015
Showing with 15 additions and 0 deletions.
  1. +15 −0 CONTRIBUTING.md
View
@@ -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!
+```

0 comments on commit af5bd7c

Please sign in to comment.