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/02/07 11:27] – [Overview] rpjdaygit_good_commits [2023/07/18 06:50] (current) – rpjday
Line 9: Line 9:
   * [[https://chris.beams.io/posts/git-commit/|Chris Beams' advice]]   * [[https://chris.beams.io/posts/git-commit/|Chris Beams' advice]]
   * [[https://stackoverflow.com/questions/15324900/standard-to-follow-when-writing-git-commit-messages|Stack Overflow advice]]   * [[https://stackoverflow.com/questions/15324900/standard-to-follow-when-writing-git-commit-messages|Stack Overflow advice]]
 +  * [[https://www.slideshare.net/TarinGamberini/commit-messages-goodpractices|SlideShare presentation]]
  
-===== Properties of a good Git commit =====+Any other good ones? 
 +===== 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 +    * 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 
-    * No ending period +b6ffdf27f3d4 s390/cpumf: Fix warning from check_processor_id 
-  * Commit should be well-defined and modular, for future cherry picking or reverting. +01f2f5b82a2b SUNRPC: fix uninitialized variable warning 
-  * Commit should be //complete//; use ''git commit --amend'' to assure this. +8c838f53e149 dpaa2-eth: fix race condition with bql frame accounting 
-  * Commit message should explain clearly:+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. 
 +    * No ending period. 
 +    * Is this changing functionality, or just fixing docs/comments. 
 +  * Commits themselves: 
 +    * Well-defined and modular, for future cherry picking or reverting. 
 +    * //Complete//; use ''git commit %%--%%amend'' to assure this. 
 +  * Commit messages:
     * What is being changed, what functionality is being affected (if any).     * What is being changed, what functionality is being affected (if any).
     * //Why// it is being changed.     * //Why// it is being changed.
Line 54: 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. You can see this 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.1518002872.txt.gz
  • Last modified: 2018/02/07 11:27
  • by rpjday