]> git.madduck.net Git - etc/vim.git/commitdiff

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Merge pull request #75 from cirosantilli/style
authorCiro Santilli <ciro.santilli@gmail.com>
Tue, 6 May 2014 07:41:43 +0000 (09:41 +0200)
committerCiro Santilli <ciro.santilli@gmail.com>
Tue, 6 May 2014 07:41:43 +0000 (09:41 +0200)
Add preferred style guide to CONTRIBUTING.

1  2 
CONTRIBUTING.md

diff --combined CONTRIBUTING.md
index 6d46e494bd6f0720dbec7baf458b003e7fb47f58,7b5122afdac0cbd25ea296fc8ef229d9435a3806..7a603db37fee283d38461892640cebab5c8f0880
@@@ -8,7 -8,7 +8,7 @@@ Every non local identifier must start w
  
  # 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.
 +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
  
@@@ -28,11 -28,17 +28,17 @@@ There are many flavors of markdown, eac
  
      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: <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 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.
  
 -Wherever possible, use test cases from the [karlcow'w Markdown Test Suite](https://github.com/karlcow/markdown-testsuite), and link to the relevant test files on your merge request.
 +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.
  
  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.