X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/886ba1b89a55ec6495f9a4c10206aa950e712211..bf2299ec92e5faa63983a1f65ab50ece5bba5e19:/CONTRIBUTING.md?ds=sidebyside diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6716ce..7b5122a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,22 +28,20 @@ There are many flavors of markdown, each one with an unique feature set. This pl Next, if there are many more than one Jekyll feature options, create a `g:vim_markdown_jekyll` option that turns them all on at once. -# Tests +# Style -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: +When choosing between multiple valid Markdown syntaxes, the default behavior must be that specified at: -``` -## Links +If you wish to have a behavior that differs from that style guide, add an option to turn it on or off, and leave it off by default. -[Link text](link URL) +# Tests -... more correct link 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. -###### FAIL: should not be highlighted as a link +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. -Text (with parenthesis) alone should not be highlighted as a link. (Issue #57) +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 failed 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. -## Code Blocks -``` +If we start disagreeing too often on what is appropriate or not, we will fork off that repository.