Skip to content

Commit

Permalink
chore: enforce commit message conventions (swagger-api#6577)
Browse files Browse the repository at this point in the history
* chore: enforce commit message conventions

* docs: add link to contributing in README
  • Loading branch information
tim-lai authored Oct 29, 2020
1 parent 7a0c1ea commit 9b0ff32
Show file tree
Hide file tree
Showing 6 changed files with 1,439 additions and 22 deletions.
25 changes: 25 additions & 0 deletions .commitlintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"extends": [
"@commitlint/config-conventional"
],
"rules": {
"header-max-length": [
2,
"always",
69
],
"scope-case": [
2,
"always",
[
"camel-case",
"kebab-case",
"upper-case"
]
],
"subject-case": [
0,
"always"
]
}
}
6 changes: 6 additions & 0 deletions .huskyrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"hooks": {
"pre-commit": "lint-staged",
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
}
3 changes: 3 additions & 0 deletions .lintstagedrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"*.js": "eslint"
}
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ Swagger UI Version | Release Date | OpenAPI Spec compatibility | Notes
- [Setting up](docs/development/setting-up.md)
- [Scripts](docs/development/scripts.md)

#### Contributing
- [Contributing](https://github.com/swagger-api/.github/blob/master/CONTRIBUTING.md)

##### Integration Tests

You will need JDK of version 7 or higher as instructed here
Expand Down
Loading

0 comments on commit 9b0ff32

Please sign in to comment.