From 882ba6e2829abff98393e6d2e61a1dac8229efd5 Mon Sep 17 00:00:00 2001 From: Marco Hinz Date: Tue, 21 May 2013 22:57:42 +0200 Subject: [PATCH] Add CONTRIBUTING.md --- .gitignore | 3 ++- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/.gitignore b/.gitignore index 3e49b19..e0ffa08 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,8 @@ !*/ !.gitignore +!CONTRIBUTING.md +!README.md !doc/signify.txt !plugin/signify.vim -!README.md !signify.png diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9f5145e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +CONTRIBUTING +============ + +If you intend to contribute to this project, please keep some simple rules in +mind: + + - the short commit message shouldn't be longer than 50 characters + - the short commit message should start with an uppercase character + - use the imperative for the short commit message + - don't finish the short commit message with a '.' + - don't use github-specific syntax to close an issue (I'll do that, when + merging into master) + - it's always a good idea to have a look at 'git log' to get an idea how to + format one's own commits + - if you have questions about a certain patch or feature requests, just open + a Github issue + +Examples +-------- + +``` +Bad: "fixed loop to start from 0 instead of 1" +Good: "Avoid off-by-one issue in skiplist loop" + +Bad: "fixed typo" +Good: "Docs: typo" +```