]> git.madduck.net Git - etc/vim.git/blobdiff - CONTRIBUTING.md

madduck's git repository

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.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Merge pull request #123 from cirosantilli/math
[etc/vim.git] / CONTRIBUTING.md
index 6d46e494bd6f0720dbec7baf458b003e7fb47f58..b29b8cc752ff828929801ea386f082b132355daf 100644 (file)
@@ -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.
 
-# 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's 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.