| 1 | # [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage Status][coverage-image]][coverage-url]
|
| 2 |
|
| 3 | > [conventional-changelog](https://github.com/ajoslin/conventional-changelog) [ember](https://github.com/emberjs/ember.js) preset
|
| 4 |
|
| 5 | **Issues with the convention itself should be reported on the Ember issue tracker.**
|
| 6 |
|
| 7 | ## Ember Convention
|
| 8 |
|
| 9 | Please use an appropriate commit prefix.
|
| 10 | If your pull request fixes an issue specify it in the commit message. Some examples:
|
| 11 |
|
| 12 | ```
|
| 13 | [DOC beta] Update CONTRIBUTING.md for commit prefixes
|
| 14 | [FEATURE query-params-new] Message
|
| 15 | [BUGFIX beta] Message
|
| 16 | [SECURITY CVE-111-1111] Message
|
| 17 | ```
|
| 18 |
|
| 19 | ## Commit Tagging
|
| 20 |
|
| 21 | All commits should be tagged. Tags are denoted by square brackets (`[]`) and come at the start of the commit message.
|
| 22 |
|
| 23 | `Tag` should not be confused with git tag.
|
| 24 | `Message` should not be confused with git commit message.
|
| 25 |
|
| 26 | ### Bug Fixes
|
| 27 |
|
| 28 | In general bug fixes are pulled into the beta branch. As such, the prefix is: `[BUGFIX beta]`. If a bug fix is a serious regression that requires a new patch release, `[BUGFIX release]` can be used instead.
|
| 29 |
|
| 30 | For bugs related to canary features, follow the prefixing rules for features.
|
| 31 |
|
| 32 | ### Cleanup
|
| 33 |
|
| 34 | Cleanup commits are for removing deprecated functionality and should be tagged
|
| 35 | as `[CLEANUP beta]`.
|
| 36 |
|
| 37 | ### Features
|
| 38 |
|
| 39 | All additions and fixes for features in canary should be tagged as `[FEATURE name]` where name is the same as the flag for that feature.
|
| 40 |
|
| 41 | ### Documentation
|
| 42 |
|
| 43 | Documentation commits are tagged as `[DOC channel]` where channel is `canary`,
|
| 44 | `beta`, or `release`. If no release is provided `canary` is assumed. The channel should be the most stable release that this documentation change applies to.
|
| 45 |
|
| 46 | ### Security
|
| 47 |
|
| 48 | Security commits will be tagged as `[SECURITY cve]`. Please do not submit security related PRs without coordinating with the security team. See the [Security Policy](http://emberjs.com/security/) for more information.
|
| 49 |
|
| 50 | ### Other
|
| 51 |
|
| 52 | In general almost all commits should fall into one of these categories. In the cases where they don't please submit your PR untagged. An Ember contributor will let you know if tagging is required.
|
| 53 |
|
| 54 | Based on https://github.com/emberjs/ember.js/blob/master/CONTRIBUTING.md
|
| 55 |
|
| 56 | [npm-image]: https://badge.fury.io/js/conventional-changelog-ember.svg
|
| 57 | [npm-url]: https://npmjs.org/package/conventional-changelog-ember
|
| 58 | [travis-image]: https://travis-ci.org/stevemao/conventional-changelog-ember.svg?branch=master
|
| 59 | [travis-url]: https://travis-ci.org/stevemao/conventional-changelog-ember
|
| 60 | [daviddm-image]: https://david-dm.org/stevemao/conventional-changelog-ember.svg?theme=shields.io
|
| 61 | [daviddm-url]: https://david-dm.org/stevemao/conventional-changelog-ember
|
| 62 | [coverage-image]: https://coveralls.io/repos/github/conventional-changelog/conventional-changelog/badge.svg?branch=master
|
| 63 | [coverage-url]: https://coveralls.io/github/conventional-changelog/conventional-changelog?branch=master
|
| 64 | |
| \ | No newline at end of file |