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
+39
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,8 @@
19
19
20
20
## Contents
21
21
22
+
*[What is commitlint](#what-is-commitlint)
23
+
*[Benefits using commitlint](#benefits-using-commitlint)
22
24
*[Getting started](#getting-started)
23
25
*[CLI](#cli)
24
26
*[Config](#config)
@@ -35,6 +37,43 @@
35
37
36
38
* * *
37
39
40
+
## What is commitlint
41
+
commitlint checks if your commit messages meet 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](#config).
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#/)
0 commit comments