From fd417ee873dded19da2f24cb2898d53c7b16b2dc Mon Sep 17 00:00:00 2001 From: Tuncer Ayaz Date: Sat, 21 May 2011 09:59:20 +0200 Subject: [PATCH] Document pull requests, branching and code style --- README.md | 20 ++++++++++++++++++-- 1 file 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 -----------------------