mirror of
https://github.com/correl/rebar.git
synced 2024-12-18 11:06:20 +00:00
Document how to write good commit messages
Based on http://gist.github.com/539516.
This commit is contained in:
parent
f505624016
commit
f76ca38e95
1 changed files with 39 additions and 0 deletions
39
HACKING
39
HACKING
|
@ -9,3 +9,42 @@ you to save this as part of custom-set-variables:
|
||||||
You can also tell Emacs to ignore file variables:
|
You can also tell Emacs to ignore file variables:
|
||||||
(setq enable-local-variables nil
|
(setq enable-local-variables nil
|
||||||
enable-local-eval 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
|
||||||
|
|
Loading…
Reference in a new issue