Skip to content

Commit 78599a3

Browse files
authored
chore: enforce commit message conventions (#1561)
This commit introduces enforcement of commit message policy describe in organization wide CONTRIBUTING.md file (https://github.com/swagger-api/.github/blob/master/CONTRIBUTING.md). Along with that, improves discovery of the global CONTRIBUTING.md file by mentioning it directly in README.md file.
1 parent 8a1cfe5 commit 78599a3

File tree

5 files changed

+643
-44
lines changed

5 files changed

+643
-44
lines changed

.commitlintrc.json

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"extends": [
3+
"@commitlint/config-conventional"
4+
],
5+
"rules": {
6+
"header-max-length": [2, "always", 69],
7+
"scope-case": [
8+
2,
9+
"always",
10+
[
11+
"camel-case",
12+
"kebab-case",
13+
"upper-case"
14+
]
15+
],
16+
"subject-case": [
17+
0,
18+
"always"
19+
]
20+
}
21+
}

.huskyrc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"hooks": {
3+
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
4+
}
5+
}

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ We'll be consolidating that soon. Just giving you the heads up. You may see refe
3232

3333
#### Development
3434

35+
- [Contributing](https://github.com/swagger-api/.github/blob/master/CONTRIBUTING.md)
3536
- [Setting up](docs/development/setting-up.md)
3637
- [Scripts](docs/development/scripts.md)
3738

0 commit comments

Comments
 (0)