summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorStefano Lattarini <stefano.lattarini@gmail.com>2013-01-10 23:06:27 +0100
committerStefano Lattarini <stefano.lattarini@gmail.com>2013-01-10 23:06:29 +0100
commitd7aef9bd0bb8df6f2acbfbae02798aa81d95370f (patch)
tree3e9b64c39e1031309e0496ad05598345eb732b6c /HACKING
parent7138cc5eefae4ab5264cacfef5937a9ab235c238 (diff)
downloadautomake-d7aef9bd0bb8df6f2acbfbae02798aa81d95370f.tar.gz
HACKING: "detailed explanation" in commit messages is almost mandatory
Signed-off-by: Stefano Lattarini <stefano.lattarini@gmail.com>
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING5
1 files changed, 3 insertions, 2 deletions
diff --git a/HACKING b/HACKING
index edafe94f1..c4f0ba815 100644
--- a/HACKING
+++ b/HACKING
@@ -148,8 +148,9 @@
<reference to relevant bugs, if any>
Here goes a more detailed explanation of why the commit is needed,
- and a general overview of what it does, and how. This section is
- optional, but you are expected to provide it more often than not.
+ and a general overview of what it does, and how. This section
+ should almost always be provided, possibly only with the expection
+ of obvious fixes or very trivial changes.
And if the detailed explanation is quite long or detailed, you can
want to break it in more paragraphs.