summaryrefslogtreecommitdiff
path: root/HACKING
blob: 6df34c55264ba767fdc0a649985894d1e2acdf11 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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