Skip to content

Commit c07d691

Browse files
committed
docs: add what-is section conventional-changelog#471
1 parent bd5eba3 commit c07d691

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

+39
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919

2020
## Contents
2121

22+
* [What is commitlint](#what-is-commitlint)
23+
* [Benefits using commitlint](#benefits-using-commitlint)
2224
* [Getting started](#getting-started)
2325
* [CLI](#cli)
2426
* [Config](#config)
@@ -35,6 +37,43 @@
3537

3638
* * *
3739

40+
## What is commitlint
41+
Commitlint is a linter which is linting your commit-messages according to the [conventional commit format](https://conventionalcommits.org).
42+
43+
In general the pattern mostly looks like this:
44+
```sh
45+
type(scope?): subject #scope is optional
46+
```
47+
Real world examples can look like this:
48+
```
49+
chore: run tests on travis ci
50+
```
51+
```
52+
fix(server): send cors headers
53+
```
54+
```
55+
feat(blog): add comment section
56+
```
57+
Common types according to [commitlint-config-conventional (based on the the Angular convention)](https://github.com/marionebl/commitlint/tree/master/%40commitlint/config-conventional#type-enum) can be:
58+
- build
59+
- ci
60+
- chore
61+
- docs
62+
- feat
63+
- fix
64+
- perf
65+
- refactor
66+
- revert
67+
- style
68+
- test
69+
70+
These can be modified by your own configuration.
71+
72+
### Benefits using commitlint
73+
- [Why Use Conventional Commits?](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#why-use-conventional-commits)
74+
- ["The perks of committing with conventions" (Talk slides)](https://slides.com/marionebl/the-perks-of-committing-with-conventions#/)
75+
76+
3877
## Getting started
3978

4079
```sh

0 commit comments

Comments
 (0)