| 1 | # conventional-changelog-atom
|
| 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-atom.svg
|
| 15 | [npm-url]: https://npmjs.com/package/conventional-changelog-atom
|
| 16 |
|
| 17 | [node]: https://img.shields.io/node/v/conventional-changelog-atom.svg
|
| 18 | [node-url]: https://nodejs.org
|
| 19 |
|
| 20 | [deps]: https://img.shields.io/librariesio/release/npm/conventional-changelog-atom
|
| 21 | [deps-url]: https://libraries.io/npm/conventional-changelog-atom/tree
|
| 22 |
|
| 23 | [size]: https://packagephobia.com/badge?p=conventional-changelog-atom
|
| 24 | [size-url]: https://packagephobia.com/result?p=conventional-changelog-atom
|
| 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) [atom](https://github.com/atom/atom) preset.
|
| 33 |
|
| 34 | **Issues with the convention itself should be reported on the Atom issue tracker.**
|
| 35 |
|
| 36 | ## Install
|
| 37 |
|
| 38 | ```bash
|
| 39 | # yarn
|
| 40 | yarn add -D conventional-changelog-atom
|
| 41 | # pnpm
|
| 42 | pnpm add -D conventional-changelog-atom
|
| 43 | # npm
|
| 44 | npm i -D conventional-changelog-atom
|
| 45 | ```
|
| 46 |
|
| 47 | ## Atom Convention
|
| 48 |
|
| 49 | ### Git Commit Messages
|
| 50 |
|
| 51 | * Use the present tense ("Add feature" not "Added feature")
|
| 52 | * Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
|
| 53 | * Limit the first line to 72 characters or less
|
| 54 | * Reference issues and pull requests liberally
|
| 55 | * Consider starting the commit message with an applicable emoji:
|
| 56 | * :art: `:art:` when improving the format/structure of the code
|
| 57 | * :racehorse: `:racehorse:` when improving performance
|
| 58 | * :non-potable_water: `:non-potable_water:` when plugging memory leaks
|
| 59 | * :memo: `:memo:` when writing docs
|
| 60 | * :penguin: `:penguin:` when fixing something on Linux
|
| 61 | * :apple: `:apple:` when fixing something on Mac OS
|
| 62 | * :checkered_flag: `:checkered_flag:` when fixing something on Windows
|
| 63 | * :bug: `:bug:` when fixing a bug
|
| 64 | * :fire: `:fire:` when removing code or files
|
| 65 | * :green_heart: `:green_heart:` when fixing the CI build
|
| 66 | * :white_check_mark: `:white_check_mark:` when adding tests
|
| 67 | * :lock: `:lock:` when dealing with security
|
| 68 | * :arrow_up: `:arrow_up:` when upgrading dependencies
|
| 69 | * :arrow_down: `:arrow_down:` when downgrading dependencies
|
| 70 | * :shirt: `:shirt:` when removing linter warnings
|
| 71 |
|
| 72 | Based on https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages
|