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
* [Promoting A High Contribution Quality](#promoting-a-high-contribution-quality)
13
-
* [Git Commit Messages](#git-commit-messages)
13
+
*[Git Commit Messages](#git-commit-messages)
14
+
* [Short Commit Messages](#short-commit-messages)
15
+
* [Issue Reference](#issue-reference)
16
+
* [Commit Nature](#commit-nature)
14
17
*[Milestone](#milestone)
15
18
*[Label](#label)
16
19
*[CHANGELOG](#changelog)
@@ -94,11 +97,11 @@ Templates should promote a high contribution quality by referring [contributing
94
97
...
95
98
```
96
99
97
-
###Git Commit Messages
100
+
## Git Commit Messages
98
101
99
-
#### Content
102
+
###Short Commit Messages
100
103
101
-
Git Commit messages should always be clear about what has been done. It should be written at the present tense and imperative Mood.
104
+
Git commit messages should help reviewers to quickly understand what has been done. It should be short, clear and written at the present tense and imperative mood.
102
105
103
106
**Preferred:**
104
107
```markdown
@@ -112,9 +115,9 @@ Git Commit messages should always be clear about what has been done. It should b
112
115
- Updates navigation storyboard.
113
116
```
114
117
115
-
####Reference
118
+
###Issue Reference
116
119
117
-
Git Commit messages should reference issues at the end.
120
+
Referencing issue in git commit messages should help anyone to track progress on a specific issue. Git commit messages should always reference issues at the end.
118
121
119
122
**Preferred:**
120
123
```markdown
@@ -128,23 +131,22 @@ Git Commit messages should reference issues at the end.
128
131
-#1024 Remove unused ViewController method.
129
132
```
130
133
131
-
#### Emojis
132
-
133
-
For clear visual identification start the commit message with an applicable emoji:
134
-
135
-
-:art:`:art:` when improving the format/structure of the code
136
-
-:racehorse:`:racehorse:` when improving performance
137
-
-:non-potable_water:`:non-potable_water:` when plugging memory leaks
138
-
-:memo:`:memo:` when writing docs
139
-
-:bug:`:bug:` when fixing a bug
140
-
-:fire:`:fire:` when removing code or files
141
-
-:green_heart:`:green_heart:` when fixing the CI build
142
-
-:white_check_mark:`:white_check_mark:` when adding tests
143
-
-:lock:`:lock:` when dealing with security
144
-
-:arrow_up:`:arrow_up:` when upgrading dependencies
145
-
-:arrow_down:`:arrow_down:` when downgrading dependencies
146
-
-:shirt:`:shirt:` when removing linter warnings
147
-
134
+
### Commit Nature
135
+
136
+
Emojis should help reviewers to quickly and visually identify the nature of the commit. For clear visual identification start the commit message with an applicable emoji:
137
+
138
+
-:art:`:art:` when improving the format/structure of the code
139
+
-:racehorse:`:racehorse:` when improving performance
140
+
-:non-potable_water:`:non-potable_water:` when plugging memory leaks
141
+
-:memo:`:memo:` when writing docs
142
+
-:bug:`:bug:` when fixing a bug
143
+
-:fire:`:fire:` when removing code or files
144
+
-:green_heart:`:green_heart:` when fixing the CI build
145
+
-:white_check_mark:`:white_check_mark:` when adding tests
146
+
-:lock:`:lock:` when dealing with security
147
+
-:arrow_up:`:arrow_up:` when upgrading dependencies
148
+
-:arrow_down:`:arrow_down:` when downgrading dependencies
0 commit comments