Vue.js/.github/COMMIT_CONVENTION.md

## 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:

``` js
/^(revert: )?(feat|fix|polish|docs|style|refactor|perf|test|workflow|ci|chore|types)(\(.+\))?: .{1,50}/
```

#### Examples

Appears under "Features" header, `compiler` subheader:

```
feat(compiler): add 'comments' option
```

Appears under "Bug Fixes" header, `v-model` subheader, with a link to issue #28:

```
fix(v-model): handle events on blur

close #28
```

Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:

```
perf(core): improve vdom diffing by removing 'foo' option

BREAKING CHANGE: The 'foo' option has been removed.
```

The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.

```
revert: feat(compiler): add 'comments' option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
```

### Full Message Format

A commit message consists of a **header**, **body** and **footer**.  The header has a **type**, **scope** and **subject**:

```
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```

The **header** is mandatory and the **scope** of the header is optional.

### Revert

If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.

### Type

If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However, if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.

Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.

### Scope

The scope could be anything specifying the place of the commit change. For example `core`, `compiler`, `ssr`, `v-model`, `transition` etc...

### Subject

The subject contains a succinct description of the change:

* use the imperative, present tense: "change" not "changed" nor "changes"
* don't capitalize the first letter
* no dot (.) at the end

### Body

Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
The body should include the motivation for the change and contrast this with previous behavior.

### Footer

The footer should contain any information about **Breaking Changes** and is also the place to
reference GitHub issues that this commit **Closes**.

**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
build: add git commit message validation 8 years ago			`## Git Commit Message Convention`

docs: update Angular's commit convention link (#7666) 7 years ago			`> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).`
build: add git commit message validation 8 years ago
workflow: improve git hooks setup 7 years ago			`#### TL;DR:`

			`Messages must be matched by the following regex:`

			``` js
workflow: add "polish" to commit types 7 years ago			`/^(revert: )?(feat\|fix\|polish\|docs\|style\|refactor\|perf\|test\|workflow\|ci\|chore\|types)(\(.+\))?: .{1,50}/`
workflow: improve git hooks setup 7 years ago			```

build: add git commit message validation 8 years ago			`#### Examples`

chore: improve commit convention examples to be more Vue-specific 8 years ago			Appears under "Features" header, `compiler` subheader:
build: add git commit message validation 8 years ago
			```
chore: improve commit convention examples to be more Vue-specific 8 years ago			`feat(compiler): add 'comments' option`
build: add git commit message validation 8 years ago			```

chore: improve commit convention examples to be more Vue-specific 8 years ago			Appears under "Bug Fixes" header, `v-model` subheader, with a link to issue #28:
build: add git commit message validation 8 years ago
			```
chore: improve commit convention examples to be more Vue-specific 8 years ago			`fix(v-model): handle events on blur`
build: add git commit message validation 8 years ago
			`close #28`
			```

			`Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:`

			```
chore: improve commit convention examples to be more Vue-specific 8 years ago			`perf(core): improve vdom diffing by removing 'foo' option`
build: add git commit message validation 8 years ago
chore: improve commit convention examples to be more Vue-specific 8 years ago			`BREAKING CHANGE: The 'foo' option has been removed.`
build: add git commit message validation 8 years ago			```

			The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.

			```
chore: improve commit convention examples to be more Vue-specific 8 years ago			`revert: feat(compiler): add 'comments' option`
build: add git commit message validation 8 years ago
			`This reverts commit 667ecc1654a317a13331b17617d973392f415f02.`
			```

			`### Full Message Format`

			`A commit message consists of a header, body and footer. The header has a type, scope and subject:`

			```
			`<type>(<scope>): <subject>`
			`<BLANK LINE>`
			`<body>`
			`<BLANK LINE>`
			`<footer>`
			```

			`The header is mandatory and the scope of the header is optional.`

			`### Revert`

docs: fix spelling and grammatical errors (#9619) 6 years ago			If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
build: add git commit message validation 8 years ago
			`### Type`

docs: fix spelling and grammatical errors (#9619) 6 years ago			If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However, if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
build: add git commit message validation 8 years ago
			Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.

			`### Scope`

docs: fix spelling and grammatical errors (#9619) 6 years ago			The scope could be anything specifying the place of the commit change. For example `core`, `compiler`, `ssr`, `v-model`, `transition` etc...
build: add git commit message validation 8 years ago
			`### Subject`

docs: fix spelling and grammatical errors (#9619) 6 years ago			`The subject contains a succinct description of the change:`
build: add git commit message validation 8 years ago
			`* use the imperative, present tense: "change" not "changed" nor "changes"`
docs: fix spelling and grammatical errors (#9619) 6 years ago			`* don't capitalize the first letter`
build: add git commit message validation 8 years ago			`* no dot (.) at the end`

			`### Body`

			`Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes".`
			`The body should include the motivation for the change and contrast this with previous behavior.`

			`### Footer`

			`The footer should contain any information about Breaking Changes and is also the place to`
			`reference GitHub issues that this commit Closes.`

			Breaking Changes should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.