Install python on OSX on travis

[etc/vim.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6d46e494bd6f0720dbec7baf458b003e7fb47f58..86912a4a67ac6b7f9f33041e17539c0eaca3f2ed 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,16 +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.
 
-# 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:
 
@@ -28,14 +32,27 @@ 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.
 
-# Tests
+## 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
+
+All new features must have unit 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.
+## Issues
 
-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.
+Issues are tracked within GitHub.
 
-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.
+When reporting issues, your report is more effective if you include a minimal example file that reproduces the problem. Try to trim out as much as possible, until you have the smallest possible file that still reproduces the issue. Paste the example inline into your issue report, quoted using four spaces at the beginning of each line, like this example from issue [#189](https://github.com/plasticboy/vim-markdown/issues/189):
 
-If the test you want to do is not appropriate for the Markdown Test Suite, create it only under the `test/` directory here.
+```
+Minimal example:
 
-If we start disagreeing too often on what is appropriate or not, we will fork off that repository.
+    ```
+    =
+    ```
+    bad!
+```