Skip to content

sodiumhalogenteam/git-emoji-commit

Repository files navigation

Git Emoji Commit 📦

git-emoji-commit npm version git-emoji-commit npm downloads

Simple CLI to encourage more concise commits.

git-emoji-commit

setup

  • $ npm i -g git-emoji-commit
  • $ git-emoji-commit --help to see options

usages

  • $gec to start the commit prompts or
  • $gec "YOUR COMMIT MESSAGE" or
  • $gec --[option] "YOUR COMMIT MESSAGE"

why?

To encourage more concise commits. Each commit type helps you keep your changes organized and brief.

Commit early, commit often. PR early, PR often.

git-emoji-commit workflow

  • $git add .
  • $gec "YOUR COMMIT MESSAGE" to make a commit
  • $git push

commit types

  • --feat or -f to make a feature commit
  • --style or -s to make a style commit
  • --fix or -x to make a fix commit
  • --chore or -c to make a chore commit
  • --doc or -d to make a docs commit
  • --refactor or -r to make a refactor commit
  • --content or -n to make a content commit
  • --test or -t to make a test commit
  • --try or -y to make a try commit
  • --build or -b to make a build commit

details

  • --help or -h to see options
  • --version or -V to see version

About

Simple CLI to encourage more concise commits using commit types with emojis

Resources

Stars

Watchers

Forks

Packages

No packages published