EmojiCommit

Have you ever found your Git commit messages a little ... boring? Well they are. Just look at them! Now you can spice them up with 🍛🍌💣 everyone's favourite characters: emoji!

Install on the command line with:

$ gem install emoji-commit

The gem installs a special commit hook script in a repo of your choosing.

Make sure you're in the root directory of a Git initialised repo (it will have the .git hidden folder in it, check it's there with ls -a). Then execute:

$ emoji install

It will prompt to confirm you want to install, hit y. Now every time you write a commit message, a random emoji from this list will be prefixed to it.

$ git commit -m 'Some boring message'

Will be added to your repo as:

:kimono: Some boring message

👘 Some boring message

Or:

:sheep: Some boring message

🐑 Some boring message

Or even:

:lock_with_ink_pen: Some boring message

🔏 Some boring message

It is random after all.

If your message already begins with an emoji in the format :foobar: then this won't be overwritten.

To remove this silly feature, in the same root directory of your project run:

$ emoji uninstall

This will delete all the files previously added, and also put the original Git commit-msg file back if this was removed.

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To give it a test run, run bundle exec emoji install.

To run the tests, run rake.

To release a new version, update the version number in emoji-commit-version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/claireparker/emoji-commit.

The gem is available as open source under the terms of the MIT License.

Here 🌟👫☀️

On Ruby gems: emoji-commit