conventional-changelog-atom
conventional-changelog atom preset.
Issues with the convention itself should be reported on the Atom issue tracker.
Install
# yarn
yarn add -D conventional-changelog-atom
# pnpm
pnpm add -D conventional-changelog-atom
# npm
npm i -D conventional-changelog-atom
Atom Convention
Git Commit Messages
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally
- Consider starting the commit message with an applicable emoji:
- :art:
:art:when improving the format/structure of the code - :racehorse:
:racehorse:when improving performance - :non-potable_water:
:non-potable_water:when plugging memory leaks - :memo:
:memo:when writing docs - :penguin:
:penguin:when fixing something on Linux - :apple:
:apple:when fixing something on Mac OS - :checkered_flag:
:checkered_flag:when fixing something on Windows - :bug:
:bug:when fixing a bug - :fire:
:fire:when removing code or files - :green_heart:
:green_heart:when fixing the CI build - :white_check_mark:
:white_check_mark:when adding tests - :lock:
:lock:when dealing with security - :arrow_up:
:arrow_up:when upgrading dependencies - :arrow_down:
:arrow_down:when downgrading dependencies - :shirt:
:shirt:when removing linter warnings
- :art:
Based on https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages