You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _posts/2025-08-14-commits.md
+21-18Lines changed: 21 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,10 +28,10 @@ This makes it easy to understand when looking at the history what are the exact
28
28
### Tagging commits
29
29
30
30
By tagging it means using part of your allocated summary to encode information into your commit message. for example:
31
-
- refactor: Changes the code but does not change any behaviour, no tests should be affected
32
-
- fix: Changes a unintended behaviour
33
-
- feat: Adds net new behaviour to the system
34
-
- cicd: only updates build and tests pipelines
31
+
-**refactor**: Changes the code but does not change any behaviour, no tests should be affected
32
+
-**fix**: Changes a unintended behaviour
33
+
-**feat**: Adds net new behaviour to the system
34
+
-**cicd**: only updates build and tests pipelines
35
35
36
36
This makes it easy to see in the past month what kinds of activities did we perform, it also gives reviewers context what code to expect in a commit.
37
37
@@ -43,26 +43,29 @@ The description of a commit message should encapsulate your thoughts around what
43
43
44
44
Some examples of good content for history:
45
45
46
-
1. How the code can be improved
47
-
2. Any challenges you encountered while writing the code
48
-
3. What were the reasons why you coded it this way
46
+
- How the code can be improved
47
+
- Any challenges you encountered while writing the code
48
+
- What were the reasons why you coded it this way
49
49
50
50
## Consistent Format
51
51
52
52
Just as we apply style guides to our codebase, commits should follow a consistent format. As long as the content is meaningful, the format does not really matter. For example:
53
53
54
-
```
55
-
summary < 50 chars
56
-
description < 72 chars (per line)
57
-
type of change: Enum(refact, fix, feat, cicd, burn)
58
54
59
-
<type of change>: <summary>
60
55
61
-
<description>
62
-
```
56
+
- summary < 50 chars
57
+
- description < 72 chars (per line)
58
+
- type of change: Enum(refact, fix, feat, cicd, burn)
0 commit comments