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: README.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ npm install -g commitizen
15
15
16
16
## Using the command line tool
17
17
18
-
### If your repo is [Commitzen-Friendly]:
18
+
### If your repo is [Commitizen-friendly]:
19
19
20
20
Simply use `git cz` instead of `git commit` when committing.
21
21
@@ -38,7 +38,7 @@ When you're working in a Commitizen friendly repository, you'll be prompted to f
38
38
39
39
[](https://github.com/commitizen/cz-cli/raw/master/meta/screenshots/add-commit.png)
40
40
41
-
### If your repo is **NOT**[Commitzen-Friendly]:
41
+
### If your repo is NOT Commitizen friendly:
42
42
43
43
If you're **not** working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit` but `npx git-cz` will use the [streamich/git-cz](https://github.com/streamich/git-cz) adapter. To fix this, you need to first [make your repo Commitizen-friendly](#making-your-repo-commitizen-friendly)
44
44
@@ -191,7 +191,7 @@ Note that the last two options **do not** require you to pass `--` before the ar
191
191
As a project maintainer of many projects, you may want to standardize on a single commit message
192
192
format for all of them. You can create your own node module which acts as front-end for commitizen.
193
193
194
-
## 1. Create your own entry point script
194
+
###1. Create your own entry point script
195
195
196
196
```
197
197
// my-cli.js
@@ -211,7 +211,7 @@ bootstrap({
211
211
});
212
212
```
213
213
214
-
## 2. Add script to package.json
214
+
###2. Add script to package.json
215
215
216
216
```
217
217
// package.json
@@ -226,7 +226,7 @@ bootstrap({
226
226
}
227
227
```
228
228
229
-
## 3. Publish it to npm and use it!
229
+
###3. Publish it to npm and use it!
230
230
231
231
```
232
232
npm install company-commit --save-dev
@@ -253,11 +253,11 @@ To create an adapter, just fork one of these great adapters and modify it to sui
253
253
254
254
## Philosophy
255
255
256
-
## About Commitizen
256
+
###About Commitizen
257
257
258
258
Commitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.
259
259
260
-
## Commitizen or Commit Hooks
260
+
###Commitizen or Commit Hooks
261
261
262
262
Both! Commitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.
263
263
@@ -304,4 +304,4 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
0 commit comments