File tree Expand file tree Collapse file tree 3 files changed +9
-58
lines changed Expand file tree Collapse file tree 3 files changed +9
-58
lines changed Original file line number Diff line number Diff line change 1
1
> Lint your commits, angular-style
2
2
3
- # commitlint- config-angular
3
+ # @ commitlint/ config-angular
4
4
Shareable ` commitlint ` config enforcing the angular commit convention.
5
5
6
- ## Installation
6
+ ## Getting started
7
7
8
8
``` sh
9
9
npm install --save-dev @commitlint/config-angular @commitlint/cli
10
+ echo ' {"extends": ["@commitlint/config-angular"]}' > .commitlintrc
10
11
```
11
12
12
- ## Usage
13
- Install and use as ` commitlint ` shareable config.
14
-
15
- ``` js
16
- // .commitlintrc
17
- {
18
- " extends" : [" angular" ]
19
- }
20
- ```
21
-
22
- ---
23
- ⇨ See [ commitlint/shareable-config] ( ../../docs/shareable-config.md ) for details
24
-
25
13
## Rules
26
14
### Problems
27
15
@@ -101,6 +89,3 @@ The following rules are considered warnings for `@commitlint/config-angular` and
101
89
``` js
102
90
eng
103
91
```
104
-
105
- ---
106
- ⇨ See [ commitlint/shareable-config] ( ../../docs/rules.md ) for available rules
Original file line number Diff line number Diff line change 3
3
# @commitlint/config-lerna-scopes
4
4
Shareable ` commitlint ` config enforcing lerna package names as scopes.
5
5
6
- ## Installation
7
-
8
- ``` shell
6
+ ## Getting started
7
+ ``` sh
9
8
npm install --save-dev @commitlint/config-lerna-scopes @commitlint/cli
10
- ```
11
-
12
- ## Usage
13
- Install and use as ` commitlint ` shareable config.
14
- ``` js
15
- // .commitlintrc
16
- {
17
- " extends" : [" angular" , " lerna-scopes" ]
18
- }
9
+ echo ' {"extends": ["@commitlint/config-lerna-scopes"]}' > .commitlintrc
19
10
```
20
11
21
12
## Examples
@@ -46,9 +37,3 @@ packages
46
37
⧗ input: chore: do some general maintenance
47
38
✔ found 0 problems, 0 warnings
48
39
```
49
-
50
- ---
51
- ⇨ See [ commitlint/shareable-config] ( /marionebl/commitlint/documentation/shareable-config.md ) for details
52
-
53
- ---
54
- Copyright (c) by [ Mario Nebl] ( https://github.com/marionebl ) and [ contributors] ( ./graphs/contributors ) . Released under the [ MIT license] ( './license.md' ) .
Original file line number Diff line number Diff line change 3
3
# @commitlint/config-patternplate
4
4
Shareable ` commitlint ` config enforcing the patternplate commit convention.
5
5
6
- ## Installation
7
- Fetch it with ` npm `
8
- ``` shell
6
+ ## Getting started
7
+ ``` sh
9
8
npm install --save-dev @commitlint/config-patternplate @commitlint/cli
9
+ echo ' {"extends": ["@commitlint/config-patternplate"]}' > .commitlintrc
10
10
```
11
11
12
-
13
- ## Usage
14
- Install and use as ` commitlint ` shareable config.
15
- ``` js
16
- // .commitlintrc
17
- {
18
- " extends" : [" patternplate" ]
19
- }
20
- ```
21
-
22
- ---
23
- ⇨ See [ commitlint/shareable-config] ( /marionebl/commitlint/documentation/shareable-config.md ) for details
24
-
25
12
## Rules
26
13
` @commitlint/config-patternplate ` extends the [ shareable angular config] ( ../config-angular#rules ) . Additionally these rules apply:
27
14
@@ -32,9 +19,3 @@ The following rules are considered problems for `@commitlint/config-patterplate`
32
19
* ** description** : ` scope ` is found in ` value `
33
20
* ** rule** : ` always `
34
21
* ** value** : determined based on pattern tree. ` system ` and all pattern ids present in ` patterns ` are allowed
35
-
36
- ---
37
- ⇨ See [ commitlint/shareable-config] ( /marionebl/commitlint/documentation/rules.md ) for available rules
38
-
39
- ---
40
- Copyright by [ Mario Nebl] ( https://github.com/marionebl ) and [ contributors] ( ./graphs/contributors ) . Released under the [ MIT license] ( './license.md' ) .
You can’t perform that action at this time.
0 commit comments