Skip to content

Commit d076f32

Browse files
committed
Initial commit
Add `README` with installation and configuration of `commitlint`. Add `LICENSE`. Add main file containing our rules.
0 parents  commit d076f32

File tree

4 files changed

+55
-0
lines changed

4 files changed

+55
-0
lines changed

LICENSE

Whitespace-only changes.

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# commitlint-config-rocketseat
2+
3+
Shareable [`commitlint`](https://github.com/marionebl/commitlint) config used by Rocketseat.
4+
5+
## Getting started
6+
7+
Installing:
8+
9+
```sh
10+
# npm
11+
npm i -D commitlint-config-rocketseat
12+
13+
# yarn
14+
yarn add -D commitlint-config-rocketseat
15+
```
16+
17+
Apply the config to `commitlint`:
18+
19+
```sh
20+
echo "module.exports = {extends: ['rocketseat']};" > commitlint.config.js
21+
```

index.js

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
module.exports = {
2+
rules: {
3+
"type-case": [2, "always", "lower-case"],
4+
"type-enum": [2, "always", ["chore", "ci", "docs", "feat", "fix", "test"]],
5+
"subject-case": [2, "always", "sentence-case"],
6+
"subject-max-length": [2, "always", 50],
7+
"subject-empty": [2, "never"],
8+
"subject-full-stop": [2, "never", "."],
9+
"body-leading-blank": [2, "always"],
10+
"body-max-line-length": [2, "always", 72],
11+
"footer-leading-blank": [2, "always"],
12+
"footer-max-line-length": [2, "always", 72]
13+
}
14+
};

package.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"name": "commitlint-config-rocketseat",
3+
"version": "0.0.1",
4+
"description": "Shareable commitlint config used by Rocketseat",
5+
"main": "index.js",
6+
"license": "MIT",
7+
"publishConfig": {
8+
"access": "public"
9+
},
10+
"repository": {
11+
"type": "git",
12+
"url": "https://github.com/Rocketseat/commitlint-config-rocketseat.git"
13+
},
14+
"keywords": [
15+
"commitlint",
16+
"config",
17+
"rocketseat",
18+
"git"
19+
]
20+
}

0 commit comments

Comments
 (0)