Skip to content

Commit 644eb50

Browse files
committed
Fix links, header levels
1 parent a0aac08 commit 644eb50

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ npm install -g commitizen
1515

1616
## Using the command line tool
1717

18-
### If your repo is [Commitzen-Friendly]:
18+
### If your repo is [Commitizen-friendly]:
1919

2020
Simply use `git cz` instead of `git commit` when committing.
2121

@@ -38,7 +38,7 @@ When you're working in a Commitizen friendly repository, you'll be prompted to f
3838

3939
[![Add and commit with Commitizen](https://github.com/commitizen/cz-cli/raw/master/meta/screenshots/add-commit.png)](https://github.com/commitizen/cz-cli/raw/master/meta/screenshots/add-commit.png)
4040

41-
### If your repo is **NOT** [Commitzen-Friendly]:
41+
### If your repo is NOT Commitizen friendly:
4242

4343
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)
4444

@@ -191,7 +191,7 @@ Note that the last two options **do not** require you to pass `--` before the ar
191191
As a project maintainer of many projects, you may want to standardize on a single commit message
192192
format for all of them. You can create your own node module which acts as front-end for commitizen.
193193

194-
## 1. Create your own entry point script
194+
### 1. Create your own entry point script
195195

196196
```
197197
// my-cli.js
@@ -211,7 +211,7 @@ bootstrap({
211211
});
212212
```
213213

214-
## 2. Add script to package.json
214+
### 2. Add script to package.json
215215

216216
```
217217
// package.json
@@ -226,7 +226,7 @@ bootstrap({
226226
}
227227
```
228228

229-
## 3. Publish it to npm and use it!
229+
### 3. Publish it to npm and use it!
230230

231231
```
232232
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
253253

254254
## Philosophy
255255

256-
## About Commitizen
256+
### About Commitizen
257257

258258
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.
259259

260-
## Commitizen or Commit Hooks
260+
### Commitizen or Commit Hooks
261261

262262
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.
263263

@@ -304,4 +304,4 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
304304
<a href="https://opencollective.com/commitizen/sponsor/8/website" target="_blank"><img src="https://opencollective.com/commitizen/sponsor/8/avatar.svg"></a>
305305
<a href="https://opencollective.com/commitizen/sponsor/9/website" target="_blank"><img src="https://opencollective.com/commitizen/sponsor/9/avatar.svg"></a>
306306

307-
[commitizen-friendly]: #making-your-repo-commitizen-friendly
307+
[Commitizen-friendly]: #making-your-repo-commitizen-friendly

0 commit comments

Comments
 (0)