rebar/HACKING

50 lines
1 KiB
Text

Indenting
=========
To have consistent indenting we have vi modeline/emacs local variable
headers in rebar's source files. This works automatically with vi.
With Emacs you have to declare 'erlang-indent-level set to 4'
as a safe local variable value. If not configured Emacs will prompt
you to save this as part of custom-set-variables:
'(safe-local-variable-values (quote ((erlang-indent-level . 4))))
You can also tell Emacs to ignore file variables:
(setq enable-local-variables nil
enable-local-eval nil)
Writing Commit Messages
=======================
One line summary (< 50 characters)
Longer description (wrap at 72 characters)
Summary
-------
* Less than 50 characters
* What was changed
* Imperative present tense (fix, add, change)
Fix bug 42
Add 'foobar' command
Change default timeout to 42
* No period
Description
-----------
* Wrap at 72 characters
* Why, explain intention and implementation approach
* Present tense
Atomicity
---------
* Break up logical changes
* Make whitespace changes separately