From c56a87508340df76cc3732df0e5a3717ef347d8e Mon Sep 17 00:00:00 2001 From: Marco Hinz Date: Wed, 6 Jan 2016 14:06:11 +0100 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7b5c6dc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +CONTRIBUTING +============ + +If you have any kind of feedback, simply create an issue on Github. This makes +it easier for everyone to track and comment recent developments. + +If you want to contribute, please keep a few simple rules in mind: + +#### The commit + +- One commit per fix/addition. +- The short commit message shouldn't be longer than 50 characters. +- The short commit message must start with an uppercase character. +- The short commit message must start with the affected section followed by a + colon (if it affects any section). +- The short commit message must use the + [imperative](https://en.wikipedia.org/wiki/Imperative_mood). +- The short commit message mustn't end with a `.`. +- It's always a good idea to have a look at other commits to get an idea how to + format one's own commits messages. + +#### Example + +``` +Bad: "added my new plugin" +Good: "Plugins: add vim-newplugin" +```