diff options
| author | Tuncer Ayaz <tuncer.ayaz@gmail.com> | 2013-06-27 21:12:27 +0200 |
|---|---|---|
| committer | Tuncer Ayaz <tuncer.ayaz@gmail.com> | 2013-09-20 20:54:23 +0200 |
| commit | 71f6e917f4963d23ed63cdd5e860b2be55842105 (patch) | |
| tree | c0818d4cf2921de2e997d338d1523d2f2f717184 /README.md | |
| parent | e840ac211280b26ec0795960c15744fe8b17affb (diff) | |
| download | rebar-71f6e917f4963d23ed63cdd5e860b2be55842105.tar.gz | |
Extract contributing guide into CONTRIBUTING.md
While at it, refactor the guide for clarity. Some of the new text was
taken from erlware/relx/CONTRIBUTING.md and modified as needed.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 72 |
1 files changed, 1 insertions, 71 deletions
@@ -51,77 +51,7 @@ and you can use rebar to build OTP-compliant apps. Contributing to rebar ===================== -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 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. vi-only users are encouraged to give [Vim -emulation](http://emacswiki.org/emacs/Evil) ([more -info](https://gitorious.org/evil/pages/Home)) a try. - -Writing Commit Messages ------------------------ - -Structure your commit message like this: - -<pre> -One line summary (less than 50 characters) - -Longer description (wrap at 72 characters) -</pre> - -### Summary - -* Less than 50 characters -* What was changed -* Imperative present tense (fix, add, change) - * `Fix bug 123` - * `Add 'foobar' command` - * `Change default timeout to 123` -* No period - -### Description - -* Wrap at 72 characters -* Why, explain intention and implementation approach -* Present tense - -### Atomicity - -* Break up logical changes -* Make whitespace changes separately - -Run checks ----------- - -Before you submit a patch, run ``make check`` to execute the test suite and -check for [xref](http://www.erlang.org/doc/man/xref.html) and -[Dialyzer](http://www.erlang.org/doc/man/dialyzer.html) warnings. You may have -to run ``make clean`` first. - -[Dialyzer](http://www.erlang.org/doc/man/dialyzer.html) warnings are compared -against a set of safe-to-ignore warnings found in -[dialyzer_reference](https://raw.github.com/rebar/rebar/master/dialyzer_reference). -[xref](http://www.erlang.org/doc/man/xref.html) is run with [custom -queries](https://raw.github.com/rebar/rebar/master/rebar.config) to suppress -safe-to-ignore warnings. +Please refer to [CONTRIBUTING](CONTRIBUTING.md). Community and Resources ----------------------- |