From: Ciro Santilli Date: Tue, 6 May 2014 07:41:43 +0000 (+0200) Subject: Merge pull request #75 from cirosantilli/style X-Git-Url: https://git.madduck.net/etc/vim.git/commitdiff_plain/1c2cccbafbbd74407d3d2209e77143a4e8207584?hp=b2c8143cd2f575012f16e60bba020e311e86097f Merge pull request #75 from cirosantilli/style Add preferred style guide to CONTRIBUTING. --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d46e49..7a603db 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,6 +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. +# Style + +When choosing between multiple valid Markdown syntaxes, the default behavior must be that specified at: + +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. + # 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.