From b94e1d31bd34a26a49ea73801be00306149f9fd4 Mon Sep 17 00:00:00 2001 From: Bailey Ling Date: Tue, 9 Jul 2013 14:41:37 +0000 Subject: [PATCH] add contribution guidelines to the readme --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e45482b7..ef1729f6 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,11 @@ if you encounter a bug, please reproduce it with this [minivimrc][g] repository # contributions -contributions and pull requests are welcome. please follow the existing coding style as much as possible. +contributions and pull requests are welcome. please take note of the following guidelines: + +* adhere to the existing style as much as possible; notably, 2 space indents and long-form keywords. +* keep the history clean! squash your branches before you submit a pull request. `pull --rebase` is your friend. +* this plugin got a lot more popular than i initially expected, if you make changes to the core, please test on as many versions of vim as possible. # license