@@ -10,6 +10,7 @@ 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)
1314* [ Milestone] ( #milestone )
1415* [ Label] ( #label )
1516* [ CHANGELOG] ( #changelog )
@@ -93,6 +94,58 @@ Templates should promote a high contribution quality by referring [contributing
9394...
9495```
9596
97+ ### Git Commit Messages
98+
99+ #### Content
100+
101+ Git Commit messages should always be clear about what has been done. It should be written at the present tense and imperative Mood.
102+
103+ ** Preferred:**
104+ ``` markdown
105+ - Add get user feature.
106+ - Update navigation storyboard.
107+ ```
108+
109+ ** Not Preferred:**
110+ ``` markdown
111+ - Added get user feature.
112+ - Updates navigation storyboard.
113+ ```
114+
115+ #### Reference
116+
117+ Git Commit messages should reference issues at the end.
118+
119+ ** Preferred:**
120+ ``` markdown
121+ - Improve cache management. Related to #42 .
122+ - Remove unused ViewController method. Related to #1024 .
123+ ```
124+
125+ ** Not Preferred:**
126+ ``` markdown
127+ - Improve cache management.
128+ - #1024 Remove unused ViewController method.
129+ ```
130+
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+
148+
96149## Milestone
97150
98151## Label
0 commit comments