Skip to content

Commit 1d5b9ee

Browse files
docs: update README.md
1 parent 5b4e798 commit 1d5b9ee

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ commitlint checks if your commit messages meets the [conventional commit format]
1010
- [Releases](#releases)
1111
- [Using go](#using-go)
1212
- [Enable in Git Repo](#enable-in-git-repo)
13-
- [Test](#test)
13+
- [Quick Test](#quick-test)
1414
- [Custom config for each repo](#custom-config-for-each-repo)
15-
- [Benefits using commitlint](#benefits-using-commitlint)
15+
- [Benefits of using commitlint](#benefits-of-using-commitlint)
1616
- [Commit Types](#commit-types)
1717
- [Library](#library)
1818
- [Config Precedence](#config-precedence)
@@ -24,7 +24,7 @@ commitlint checks if your commit messages meets the [conventional commit format]
2424

2525
#### Releases
2626

27-
Download binary from [releases](https://github.com/conventionalcommit/commitlint/releases) and add the path to your `PATH`
27+
Download binary from [releases](https://github.com/conventionalcommit/commitlint/releases) and add it to your `PATH`
2828

2929
#### Using go
3030

@@ -46,7 +46,7 @@ go install github.com/conventionalcommit/commitlint@latest
4646
commitlint init --global
4747
```
4848

49-
### Test
49+
### Quick Test
5050

5151
```bash
5252
# invalid commit message
@@ -61,10 +61,12 @@ echo "feat: good commit message" | commitlint lint
6161
### Custom config for each repo
6262

6363
- run `commitlint create config` in repo root directory
64-
- this will create `commitlint.yaml` in that directory
65-
- you can customise the config to your need
6664

67-
### Benefits using commitlint
65+
this will create `commitlint.yaml` in that directory, you can customise the config to your need
66+
67+
- run `commitlint verify` to verify if config is valid or not
68+
69+
### Benefits of using commitlint
6870

6971
- [Why Use Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#why-use-conventional-commits)
7072

0 commit comments

Comments
 (0)