Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
| git_good_commits [2018/06/05 19:19] – [Properties of a good Git commit (sort of subjective)] rpjday | git_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 | + | * 60 char max (including subsystem name) for '' |
| - | * Be // | + | < |
| - | * 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) | ||
| + | </ | ||
| + | * Be // | ||
| + | * Use the imperative mood (" | ||
| * Don't capitalize the first word. | * Don't capitalize the first word. | ||
| * No ending period. | * No ending period. | ||
| + | * Is this changing functionality, | ||
| * Commits themselves: | * Commits themselves: | ||
| * Well-defined and modular, for future cherry picking or reverting. | * Well-defined and modular, for future cherry picking or reverting. | ||
| Line 27: | Line 35: | ||
| * 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. | ||
| - | * Explicit explanation if this changes functionality, | ||
| * References to discussions about this commit (people, mailing lists). | * References to discussions about this commit (people, mailing lists). | ||
| * Level of testing this commit has had. | * Level of testing this commit has had. | ||
| Line 59: | Line 66: | ||
| </ | </ | ||
| - | If several files are being touched, use '' | ||
| - | |||
| - | < | ||
| - | $ git show --stat 6ff005cf19363382fc867d7876a75fd8a386e894 | ||
| - | commit 6ff005cf19363382fc867d7876a75fd8a386e894 | ||
| - | Author: Dave Prue < | ||
| - | 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 | ||
| - | " | ||
| - | (sha1: 4d43d065db3262f9a9918ba72457bf36dfb8e0bb) | ||
| - | | ||
| - | Signed-off-by: | ||
| - | Reviewed-by: | ||
| - | Reviewed-by: | ||
| - | Reviewed-by: | ||
| - | Tested-by: Mark Kettenis < | ||
| - | [Tweek commit message, config_whitelist.txt, | ||
| - | Signed-off-by: | ||
| - | |||
| - | | ||
| - | | ||
| - | | ||
| - | | ||
| - | | ||
| - | 5 files changed, 5 insertions(+), | ||
| - | $ | ||
| - | </ | ||