UNPKG

3.69 kBMarkdownView Raw
1# conventional-changelog-ember
2
3[![ESM-only package][package]][package-url]
4[![NPM version][npm]][npm-url]
5[![Node version][node]][node-url]
6[![Dependencies status][deps]][deps-url]
7[![Install size][size]][size-url]
8[![Build status][build]][build-url]
9[![Coverage status][coverage]][coverage-url]
10
11[package]: https://img.shields.io/badge/package-ESM--only-ffe536.svg
12[package-url]: https://nodejs.org/api/esm.html
13
14[npm]: https://img.shields.io/npm/v/conventional-changelog-ember.svg
15[npm-url]: https://npmjs.com/package/conventional-changelog-ember
16
17[node]: https://img.shields.io/node/v/conventional-changelog-ember.svg
18[node-url]: https://nodejs.org
19
20[deps]: https://img.shields.io/librariesio/release/npm/conventional-changelog-ember
21[deps-url]: https://libraries.io/npm/conventional-changelog-ember/tree
22
23[size]: https://packagephobia.com/badge?p=conventional-changelog-ember
24[size-url]: https://packagephobia.com/result?p=conventional-changelog-ember
25
26[build]: https://img.shields.io/github/actions/workflow/status/conventional-changelog/conventional-changelog/tests.yaml?branch=master
27[build-url]: https://github.com/conventional-changelog/conventional-changelog/actions
28
29[coverage]: https://coveralls.io/repos/github/conventional-changelog/conventional-changelog/badge.svg?branch=master
30[coverage-url]: https://coveralls.io/github/conventional-changelog/conventional-changelog?branch=master
31
32[conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) [ember](https://github.com/emberjs/ember.js) preset.
33
34**Issues with the convention itself should be reported on the Ember issue tracker.**
35
36## Install
37
38```bash
39# yarn
40yarn add -D conventional-changelog-ember
41# pnpm
42pnpm add -D conventional-changelog-ember
43# npm
44npm i -D conventional-changelog-ember
45```
46
47## Ember Convention
48
49Please use an appropriate commit prefix.
50If your pull request fixes an issue specify it in the commit message. Some examples:
51
52 ```
53 [DOC beta] Update CONTRIBUTING.md for commit prefixes
54 [FEATURE query-params-new] Message
55 [BUGFIX beta] Message
56 [SECURITY CVE-111-1111] Message
57 ```
58
59## Commit Tagging
60
61All commits should be tagged. Tags are denoted by square brackets (`[]`) and come at the start of the commit message.
62
63`Tag` should not be confused with git tag.
64`Message` should not be confused with git commit message.
65
66### Bug Fixes
67
68In 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.
69
70For bugs related to canary features, follow the prefixing rules for features.
71
72### Cleanup
73
74Cleanup commits are for removing deprecated functionality and should be tagged
75as `[CLEANUP beta]`.
76
77### Features
78
79All additions and fixes for features in canary should be tagged as `[FEATURE name]` where name is the same as the flag for that feature.
80
81### Documentation
82
83Documentation commits are tagged as `[DOC channel]` where channel is `canary`,
84`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.
85
86### Security
87
88Security 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.
89
90### Other
91
92In 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.
93
94Based on https://github.com/emberjs/ember.js/blob/master/CONTRIBUTING.md
95
\No newline at end of file