Skip to content

Commit 032a5dc

Browse files
committed
📝 Improve Git Commit Messages section.
- Use why format for each sub section. - Improve title for a better understanding.
1 parent 2f96ff4 commit 032a5dc

1 file changed

Lines changed: 25 additions & 23 deletions

File tree

README.md

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ These guidelines are based on [Building a strong community Github documentation]
1010
* [Multiple Issue Templates Over Single Issue Template](#multiple-issue-template-over-single-issue-template)
1111
* [Issue & Pull Request Expectation](#issue--pull-request-expectation)
1212
* [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)
1417
* [Milestone](#milestone)
1518
* [Label](#label)
1619
* [CHANGELOG](#changelog)
@@ -94,11 +97,11 @@ Templates should promote a high contribution quality by referring [contributing
9497
...
9598
```
9699

97-
### Git Commit Messages
100+
## Git Commit Messages
98101

99-
#### Content
102+
### Short Commit Messages
100103

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.
102105

103106
**Preferred:**
104107
```markdown
@@ -112,9 +115,9 @@ Git Commit messages should always be clear about what has been done. It should b
112115
- Updates navigation storyboard.
113116
```
114117

115-
#### Reference
118+
### Issue Reference
116119

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.
118121

119122
**Preferred:**
120123
```markdown
@@ -128,23 +131,22 @@ Git Commit messages should reference issues at the end.
128131
- #1024 Remove unused ViewController method.
129132
```
130133

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
149+
- :shirt: `:shirt:` when removing linter warnings
148150

149151
## Milestone
150152

0 commit comments

Comments
 (0)