From: Ciro Santilli 六四事件 法轮功 包卓轩 Date: Tue, 19 Jan 2016 12:39:18 +0000 (-0500) Subject: Merge pull request #245 from cirosantilli/contributing-headers X-Git-Url: https://git.madduck.net/etc/vim.git/commitdiff_plain/ae7229f00484cfa06e41891152b5350ebedb7f3b?hp=1b37c6c879c6fcdd5f96ef12b95eeda2e0b416e7 Merge pull request #245 from cirosantilli/contributing-headers Make contributing headers h2 like README --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 832072d..86912a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,18 +1,20 @@ +# 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. 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 +## 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: @@ -30,17 +32,17 @@ 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 +## 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 +## Tests All new features must have unit tests. -# Issues +## Issues Issues are tracked within GitHub.