[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 3/8] HACKING: "detailed explanation" in commit messages is almost
From: |
Stefano Lattarini |
Subject: |
[PATCH 3/8] HACKING: "detailed explanation" in commit messages is almost mandatory |
Date: |
Thu, 10 Jan 2013 23:29:39 +0100 |
Signed-off-by: Stefano Lattarini <address@hidden>
---
HACKING | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/HACKING b/HACKING
index edafe94..c4f0ba8 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.
--
1.8.1.rc3.192.g2d0029e
- [PATCH 0/8] Few minor improvements to HACKING, Stefano Lattarini, 2013/01/10
- [PATCH 2/8] HACKING: we use "merge --log" even when merging master, Stefano Lattarini, 2013/01/10
- [PATCH 1/8] HACKING: typofix, Stefano Lattarini, 2013/01/10
- [PATCH 3/8] HACKING: "detailed explanation" in commit messages is almost mandatory,
Stefano Lattarini <=
- [PATCH 4/8] HACKING: commit messages are not to follow GCS ChangeLog rules too strongly, Stefano Lattarini, 2013/01/10
- [PATCH 5/8] HACKING: fixlets about git branch rewinding policy, Stefano Lattarini, 2013/01/10
- [PATCH 6/8] HACKING: rewindable branches should live in the 'experimental/*' namespace, Stefano Lattarini, 2013/01/10
- [PATCH 7/8] HACKING: bug-tracker, the PLANS directory, and how to plan "big" changes, Stefano Lattarini, 2013/01/10
- [PATCH 8/8] HACKING: minor typofix, Stefano Lattarini, 2013/01/10