conventional-changelog-atom

5.0.0 • Public • Published

conventional-changelog-atom

ESM-only package NPM version Node version Dependencies status Install size Build status Coverage status

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: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 🚱 :non-potable_water: when plugging memory leaks
    • 📝 :memo: when writing docs
    • 🐧 :penguin: when fixing something on Linux
    • 🍎 :apple: when fixing something on Mac OS
    • 🏁 :checkered_flag: when fixing something on Windows
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • 👕 :shirt: when removing linter warnings

Based on https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages

Package Sidebar

Install

npm i conventional-changelog-atom

Weekly Downloads

1,373,703

Version

5.0.0

License

ISC

Unpacked Size

8.11 kB

Total Files

10

Last publish

Collaborators

  • bcoe
  • oss-bot
  • stevemao
  • tapppi