2020-05-29 13:29:24 +00:00
## Git Commit Message Convention
> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
#### TL;DR:
Messages must be matched by the following regex:
2021-03-31 20:06:16 +00:00
<!-- prettier - ignore -->
```js
2022-12-14 21:12:02 +00:00
/^(revert: )?(feat|fix|docs|style|refactor|perf|test|build|ci|chore)(\(.+\))?!?: .{1,50}/
2020-05-29 13:29:24 +00:00
```
#### Examples
```
feat(dev): add 'comments' option
fix(dev): fix dev error
2022-12-14 21:12:02 +00:00
perf(build)!: remove 'foo' option
2020-05-29 13:29:24 +00:00
revert: feat(compiler): add 'comments' option
```
### Revert
2022-12-14 21:12:02 +00:00
If the PR reverts a previous commit, it should begin with `revert: ` , followed by the header of the reverted commit
2020-05-29 13:29:24 +00:00
### Scope
The scope could be anything specifying the place of the commit change. For example `dev` , `build` , `workflow` , `cli` etc...
### Subject
The subject contains a succinct description of the change:
2021-03-31 20:06:16 +00:00
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize the first letter
- no dot (.) at the end