Skip to content

Commit 8dd94f0

Browse files
docs: update README
1 parent 2f3b9c4 commit 8dd94f0

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# commitlint
44

5-
commitlint checks if your commit messages meets the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/)
5+
commitlint checks if your commit message meets the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/)
66

77
```
88
<type>[optional scope]: <description>
@@ -117,6 +117,10 @@ To lint a message, you can use any one of the following
117117
- commit message file passed to `--message` command-line argument
118118
- `.git/COMMIT_EDITMSG` in current directory
119119

120+
#### hook
121+
122+
- To create hook files, run `commitlint hook create`
123+
120124
### Default Config
121125

122126
```yaml
@@ -232,6 +236,10 @@ Total 1 errors, 0 warnings
232236

233237
To create a sample config, run `commitlint config create`
234238

239+
- How can I skip lint check for a commit?
240+
241+
use `--no-verify` flag with `git commit` which skips commit hooks
242+
235243
## License
236244

237245
All packages are licensed under [MIT License](https://github.com/conventionalcommit/commitlint/tree/master/LICENSE.md)

0 commit comments

Comments
 (0)