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.
@@ -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,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.
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: <http://www.cirosantilli.com/markdown-styleguide>
-```
-## 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's 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.
projects / etc / vim.git / blobdiff