add test file for folding

[etc/vim.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7a603db37fee283d38461892640cebab5c8f0880..a2c158087b5759bcdb1c039aa4b4d953676c08ca 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -36,12 +36,19 @@ If you wish to have a behavior that differs from that style guide, add an option
 
 # Tests
 
 
 # Tests
 

-All new features must have tests. We don't require unit tests: tests that require users to open markdown code in Vim and check things manually are accepted, but you should point clearly to where the tests are.
+All new features must have unit tests.

 
 

-Wherever possible, use test cases from the [karlcow's Markdown Test Suite](https://github.com/karlcow/markdown-testsuite), and link to the relevant test files on your merge request.
+# Issues

 
 

-If a test does not exist there yet, make a pull request to them, and link to that pull request on the pull request you make here.
+Issues are tracked within GitHub.

 
 

-If the test you want to do is not appropriate for the Markdown Test Suite, create it only under the `test/` directory here.
+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):

 
 

-If we start disagreeing too often on what is appropriate or not, we will fork off that repository.
+```
+Minimal example:
+
+    ```
+    =
+    ```
+    bad!
+```