From bf2299ec92e5faa63983a1f65ab50ece5bba5e19 Mon Sep 17 00:00:00 2001 From: Ciro Santilli Date: Wed, 23 Apr 2014 14:32:26 +0200 Subject: [PATCH 1/1] Add preferred style guide to CONTRIBUTING. --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c51d65b..7b5122a 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. -- 2.39.5