Skip to content

Commit 153c742

Browse files
committed
docs: unify config docs
1 parent 646b0a0 commit 153c742

File tree

3 files changed

+9
-58
lines changed

3 files changed

+9
-58
lines changed

@commitlint/config-angular/readme.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,15 @@
11
> Lint your commits, angular-style
22
3-
# commitlint-config-angular
3+
# @commitlint/config-angular
44
Shareable `commitlint` config enforcing the angular commit convention.
55

6-
## Installation
6+
## Getting started
77

88
```sh
99
npm install --save-dev @commitlint/config-angular @commitlint/cli
10+
echo '{"extends": ["@commitlint/config-angular"]}' > .commitlintrc
1011
```
1112

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-
2513
## Rules
2614
### Problems
2715

@@ -101,6 +89,3 @@ The following rules are considered warnings for `@commitlint/config-angular` and
10189
```js
10290
eng
10391
```
104-
105-
---
106-
⇨ See [commitlint/shareable-config](../../docs/rules.md) for available rules

@commitlint/config-lerna-scopes/readme.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,10 @@
33
# @commitlint/config-lerna-scopes
44
Shareable `commitlint` config enforcing lerna package names as scopes.
55

6-
## Installation
7-
8-
```shell
6+
## Getting started
7+
```sh
98
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
1910
```
2011

2112
## Examples
@@ -46,9 +37,3 @@ packages
4637
⧗ input: chore: do some general maintenance
4738
✔ found 0 problems, 0 warnings
4839
```
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').

@commitlint/config-patternplate/readme.md

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,12 @@
33
# @commitlint/config-patternplate
44
Shareable `commitlint` config enforcing the patternplate commit convention.
55

6-
## Installation
7-
Fetch it with `npm`
8-
```shell
6+
## Getting started
7+
```sh
98
npm install --save-dev @commitlint/config-patternplate @commitlint/cli
9+
echo '{"extends": ["@commitlint/config-patternplate"]}' > .commitlintrc
1010
```
1111

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-
2512
## Rules
2613
`@commitlint/config-patternplate` extends the [shareable angular config](../config-angular#rules). Additionally these rules apply:
2714

@@ -32,9 +19,3 @@ The following rules are considered problems for `@commitlint/config-patterplate`
3219
* **description**: `scope` is found in `value`
3320
* **rule**: `always`
3421
* **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').

0 commit comments

Comments
 (0)