X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/bf2299ec92e5faa63983a1f65ab50ece5bba5e19..74c9c60796ef10284ba26aaf38ffb39beae5f62c:/CONTRIBUTING.md?ds=sidebyside diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b5122a..b29b8cc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ Every non local identifier must start with `g:vim_markdown_`. # Documentation -Every new feature must be documented under in the [README.md](README.md). Documentation must be written in [GFM](https://help.github.com/articles/github-flavored-markdown) since Github itself is the primary to HTML converter used. In particular, remember that GFM adds line breaks at single newlines, so just forget about the 70 characters wide rule. +Every new feature must be documented under in the [README.md](README.md). Documentation must be written in [GFM](https://help.github.com/articles/github-flavored-markdown) since GitHub itself is the primary to HTML converter used. In particular, remember that GFM adds line breaks at single newlines, so just forget about the 70 characters wide rule. # Markdown Flavors @@ -36,12 +36,4 @@ If you wish to have a behavior that differs from that style guide, add an option # 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. - -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. - -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. - -If the test you want to do is not appropriate for the Markdown Test Suite, create it only under the `test/` directory here. - -If we start disagreeing too often on what is appropriate or not, we will fork off that repository. +All new features must have unit tests.