Add unit tests and travis support.

[etc/vim.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c51d65bd05e96a94d4b51fd2b486113837598aa5..b29b8cc752ff828929801ea386f082b132355daf 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,7 +8,7 @@ Every non local identifier must start with `g:vim_markdown_`.
 
 # Documentation
 
 
 # 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
 
 
 # Markdown Flavors
 


@@ -28,14 +28,12 @@ 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.
 
 
     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
-
-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.
+# Style

 
 

-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.
+When choosing between multiple valid Markdown syntaxes, the default behavior must be that specified at: <http://www.cirosantilli.com/markdown-styleguide>

 
 

-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 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.

 
 

-If the test you want to do is not appropriate for the Markdown Test Suite, create it only under the `test/` directory here.
+# Tests

 
 

-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.