git_good_commits

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
git_good_commits [2018/06/05 19:20] – [Properties of a good Git commit (sort of subjective)] rpjdaygit_good_commits [2023/07/18 06:50] (current) – rpjday
Line 14: Line 14:
 ===== Properties of a good Git commit (sort of subjective) ===== ===== Properties of a good Git commit (sort of subjective) =====
  
-  * Subject (first) line: +  * Subject (first) line (followed by blank line): 
-    * 60 characters or less for pretty-printing (''git log %%--%%oneline''). +    * 60 char max (including subsystem name) for ''git log %%--%%oneline''). 
-    * Be //accurate//. +<code> 
-    * Include subsystem name at front if possible. +8c7ae38d1ce1 afs: Fix StoreData op marshalling 
-    * Use the imperative mood.+7d6ab823d646 vfs: Update mount API docs 
 +b6ffdf27f3d4 s390/cpumf: Fix warning from check_processor_id 
 +01f2f5b82a2b SUNRPC: fix uninitialized variable warning 
 +8c838f53e149 dpaa2-eth: fix race condition with bql frame accounting 
 +047a013f8d0a chelsio: use BUG() instead of BUG_ON(1) 
 +</code> 
 +    * Be //accurate//; the subject must describe the actual commit. 
 +    * Use the imperative mood ("Fix", "Adjust", "Correct").
     * Don't capitalize the first word.     * Don't capitalize the first word.
     * No ending period.     * No ending period.
Line 59: Line 66:
 </code> </code>
  
-If several files are being touched, use ''git diff %%--%%stat'' to generate a summary, and add that info to the commit message. Even if you don't add this to the commit message, you can see it later with ''git show %%--%%stat'': 
- 
-<code> 
-$ git show --stat 6ff005cf19363382fc867d7876a75fd8a386e894 
-commit 6ff005cf19363382fc867d7876a75fd8a386e894 
-Author: Dave Prue <dave@prue.com> 
-Date:   Thu Aug 31 19:21:01 2017 +0200 
- 
-    sunxi: Fix CONFIG_SUNXI_GMAC references 
-     
-    SUNXI_GMAC was still used to configure the code where as the 
-    same has been renamed and moved to Kconfig in below commit 
-    "sunxi: Move SUNXI_GMAC to Kconfig" 
-    (sha1: 4d43d065db3262f9a9918ba72457bf36dfb8e0bb) 
-     
-    Signed-off-by: Dave Prue <dave@prue.com> 
-    Reviewed-by: Simon Glass <sjg@chromium.org> 
-    Reviewed-by: Jagan Teki <jagan@openedev.com> 
-    Reviewed-by: Mark Kettenis <kettenis@openbsd.org> 
-    Tested-by: Mark Kettenis <kettenis@openbsd.org> 
-    [Tweek commit message, config_whitelist.txt, build-whitelist.sh] 
-    Signed-off-by: Jagan Teki <jagan@openedev.com> 
- 
- arch/arm/include/asm/arch-sunxi/sys_proto.h | 2 +- 
- board/sunxi/Makefile                        | 2 +- 
- include/configs/sunxi-common.h              | 2 +- 
- scripts/build-whitelist.sh                  | 4 ++-- 
- scripts/config_whitelist.txt                | 1 - 
- 5 files changed, 5 insertions(+), 6 deletions(-) 
-$ 
-</code> 
  • git_good_commits.1528226424.txt.gz
  • Last modified: 2018/06/05 19:20
  • by rpjday