summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTuncer Ayaz <tuncer.ayaz@gmail.com>2011-05-21 09:59:20 +0200
committerTuncer Ayaz <tuncer.ayaz@gmail.com>2011-05-21 10:16:22 +0200
commitfd417ee873dded19da2f24cb2898d53c7b16b2dc (patch)
tree1cfc9d065f748e5882b6b86f98eaf763d2e7170d /README.md
parentea8aca4519178287ce5ee706f9d1c88d2b864f2a (diff)
downloadrebar-fd417ee873dded19da2f24cb2898d53c7b16b2dc.tar.gz
Document pull requests, branching and code style
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 18 insertions, 2 deletions
diff --git a/README.md b/README.md
index 6b66d22..57ddb01 100644
--- a/README.md
+++ b/README.md
@@ -46,13 +46,29 @@ Clone the git repository:
Contributing to rebar
=====================
-Coding style
-------------
+Pull requests and branching
+---------------------------
+
+Use one topic branch per pull request.
+
+Do not commit to master in your fork.
+
+Provide a clean branch without any merge commits from upstream.
+
+Usually you should collapse (squash) any intermediate commits into the original single commit.
+
+Code style
+----------
Do not introduce trailing whitespace.
+Do not mix spaces and tabs.
+
Do not introduce lines longer than 80 characters.
+[erlang-mode (emacs)](http://www.erlang.org/doc/man/erlang.el.html) indentation is preferred.
+If you prefer vi, consider extending emacs with [Vimpulse](http://www.emacswiki.org/emacs/Vimpulse).
+
Writing Commit Messages
-----------------------