+# CONTRIBUTING
+
These contributing guidelines were accepted rather late in the history of this plugin, after much code had already been written.
If you find any existing behavior which does not conform to these guidelines, please correct it and send a pull request.
-# General Rules
+## General Rules
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.
-# Markdown Flavors
+Vim help file [doc/vim-markdown.txt](doc/vim-markdown.txt) will be generated from [README.md](README.md) by `make doc` using [vim-tools](https://github.com/xolox/vim-tools).
+
+## Markdown Flavors
There are many flavors of markdown, each one with an unique feature set. This plugin uses the following strategy to deal with all those flavors:
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
+## Style
When choosing between multiple valid Markdown syntaxes, the default behavior must be that specified at: <http://www.cirosantilli.com/markdown-styleguide>
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
+## Tests
All new features must have unit tests.
-# Issues
+## Issues
Issues are tracked within GitHub.
projects / etc / vim.git / blobdiff