X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/bb8aeb1fcf3fa51193fefee1546ee25bfa454e4a..290d61b8387ae5bb6b471b643127aa568e55a77e:/CONTRIBUTING.md?ds=inline diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6716ce..c51d65b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,20 +30,12 @@ There are many flavors of markdown, each one with an unique feature set. This pl # Tests -All new features must have tests. While we don't require unit tests, which are too hard to do in certain cases, you should create a test under the `test/` directory with a predictable name which allows other users to quickly test your feature. Good tests should explain their expected input / output behavior. Failing test should be marked with `FAIL` somewhere near the test, possibly explaining why it fails. For example: +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. -``` -## Links +Wherever possible, use test cases from the [karlcow'w Markdown Test Suite](https://github.com/karlcow/markdown-testsuite), and link to the relevant test files on your merge request. -[Link text](link URL) +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. -... more correct link tests ... +If the test you want to do is not appropriate for the Markdown Test Suite, create it only under the `test/` directory here. -###### FAIL: should not be highlighted as a link - -Text (with parenthesis) alone should not be highlighted as a link. (Issue #57) - -... more failed link tests ... - -## Code Blocks -``` +If we start disagreeing too often on what is appropriate or not, we will fork off that repository.