7 Anatomy of a commit message
7 Anatomy of a commit message
Command:
1
$ cat example_commit.txt
Code output:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Provide a good commit message example
The purpose of this commit is to provide an example of a hand-crafted,
artisanal commit message. The first line is a short, approximately 50-character
summary, followed by an empty line. The subsequent paragraphs are jam-packed
with descriptive information about the change, but each line is kept under 72
characters in length.
If even more information is needed to explain the change, more paragraphs can
be added after blank lines, with links to issues, tickets, or bugs. Remember
that future you will thank current you for your thoughtfulness and foresight!
# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# On branch master
#
# Changes to be committed:
# new file: super_script.py
# new file: cool_config.txt
#
Command:
1
2
$ cd scripts
$ git log
Code output:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
commit d8e139cc4f7dcd13b75cff67cfb68527e24c59c5 (HEAD -> master)
Author: artwalker <artwalker@example.com>
Date: Thu Jul 11 17:19:32 2023 +0200
Add a check_reboot function
commit 6cfc29966acda8213fcd8ac2735b31f3fdbc6c53
Author: artwalker <artwalker@example.com>
Date: Thu Jul 11 12:08:46 2023 +0200
Create and empty all_checks.py
This post is licensed under CC BY 4.0 by the author.