-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathcommitlint.config.js
44 lines (42 loc) · 1.56 KB
/
commitlint.config.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
/**
* @type {import('@commitlint/types').UserConfig}
*
* Commit Message Guidelines
*
* All commit message MUST follow https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
*
* Format as:
*
* ```
* <type>(<scope>): <subject>
* <BLANK LINE>
* <body>
* <BLANK LINE>
* <footer>
* ```
* Note: The **<type>** can be found in **./commitlint.config.js** file.
*/
module.exports = {
rules: {
'body-leading-blank': [1, 'always'],
'footer-leading-blank': [1, 'always'],
'header-max-length': [2, 'always', 72],
'scope-case': [2, 'always', 'lower-case'],
'subject-case': [2, 'never', ['sentence-case', 'start-case', 'pascal-case', 'upper-case']],
'subject-empty': [2, 'never'],
'subject-full-stop': [2, 'never', '.'],
'type-case': [2, 'always', 'lower-case'],
'type-empty': [2, 'never'],
'type-enum': [2, 'always', [
'breaking', // A commit that is tagged with breaking will be used by semantic-release to create a major release.
'build', // Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
'ci', // Changes to our CI configuration files and scripts (examples: GitHub Actions, etc.)
'docs', // Documentation only changes
'feat', // A new feature
'fix', // A bug fix
'perf', // A code change that improves performance
'refactor', // A code change that neither fixes a bug nor adds a feature
'test', // Adding missing tests or correcting existing tests
]],
},
};