aboutsummaryrefslogtreecommitdiff
path: root/vim/.vim/bundle/vim-startify/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'vim/.vim/bundle/vim-startify/CONTRIBUTING.md')
-rw-r--r--vim/.vim/bundle/vim-startify/CONTRIBUTING.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/vim/.vim/bundle/vim-startify/CONTRIBUTING.md b/vim/.vim/bundle/vim-startify/CONTRIBUTING.md
new file mode 100644
index 0000000..a01753e
--- /dev/null
+++ b/vim/.vim/bundle/vim-startify/CONTRIBUTING.md
@@ -0,0 +1,28 @@
+CONTRIBUTING
+============
+
+If you intend to contribute to this project, please keep some simple rules in
+mind:
+
+ - one commit per feature/fix
+ - 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"
+```