Skip to content

Commit

Permalink
chore: improve commit convention examples to be more Vue-specific
Browse files Browse the repository at this point in the history
  • Loading branch information
yyx990803 committed Jul 1, 2017
1 parent eea0920 commit 275d95d
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions .github/COMMIT_CONVENTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,32 @@
#### Examples

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

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

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

```
fix(graphite): stop graphite breaking when width < 0.1
fix(v-model): handle events on blur
close #28
```

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

```
perf(pencil): remove graphiteWidth option
perf(core): improve vdom diffing by removing 'foo' option
BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reason.
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(pencil): add 'graphiteWidth' option
revert: feat(compiler): add 'comments' option
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
```
Expand Down

0 comments on commit 275d95d

Please sign in to comment.