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
-[Exceptions to Lowercase Branding](#exceptions-to-lowercase-branding)
15
21
-[License](#license)
16
22
17
23
## Local Setup Guide
@@ -130,6 +136,39 @@ We welcome contributions! Follow these steps to get started.
130
136
git add .
131
137
git commit -m "Brief description of your changes"
132
138
```
139
+
#### Commit Message Format
140
+
141
+
We use [Commitizen](https://www.npmjs.com/package/commitizen) with the [git-cz](https://www.npmjs.com/package/git-cz) adapter to ensure consistent commit messages that follow a standard changelog style. This helps in generating changelogs and maintaining a clear project history.
142
+
143
+
Commit messages should follow this pattern:
144
+
145
+
```
146
+
<type>: [#<GIT-ISSUE>] <subject>
147
+
```
148
+
-**type**: The type of change that you're committing. It should be one of the following:
149
+
-**feat**: A new feature
150
+
-**fix**: A bug fix
151
+
-**docs**: Documentation only changes
152
+
-**style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
153
+
-**refactor**: A code change that neither fixes a bug nor adds a feature
154
+
-**perf**: A code change that improves performance
155
+
-**test**: Adding missing tests or correcting existing tests
156
+
-**chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
157
+
-**ci**: Changes to CI configuration files and scripts
158
+
159
+
-**GIT-ISSUE**: The Git issue ID associated with the change.
160
+
-**subject**: A brief description of the change.
161
+
162
+
### Example Commit Messages:
163
+
164
+
-`feat: [#1] Add user login functionality`
165
+
-`fix: [#24] Resolve navbar alignment issue`
166
+
-`chore: [#101] Update dependencies to latest versions`
167
+
168
+
### Using Commitizen with Husky
169
+
170
+
We have configured [Husky](https://www.npmjs.com/package/husky) to automatically run Commitizen when you commit changes. This is done using the `prepare-commit-msg` hook. Simply use the `git commit` command, and Commitizen will guide you through the commit message creation process.
0 commit comments