Every one of the projects in this repository is available at the canonical
URL git://git.madduck.net/madduck/pub/<projectpath> — see
each project's metadata for the exact URL.
All patches and comments are welcome. Please squash your changes to logical
commits before using git-format-patch and git-send-email to
patches@git.madduck.net.
If you'd read over the Git project's submission guidelines and adhered to them,
I'd be especially grateful.
@@ -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.
projects / etc / vim.git / blobdiff