Lolcommits Twitter

Gem Version Travis Build Status Coverage Status Code Climate Gem Dependency Status

lolcommits takes a snapshot with your webcam every time you git commit code, and archives a lolcat style image with it. Git blame has never been so much fun!

This plugin automatically posts your Lolcommit to Twitter. The tweet features your commit message (shortened) and the lolcommit image (along with some optional prefix or postfix text). Check out the #lolcommits hashtag for examples.

You can optionally open the new tweet in your default browser.

Requirements

Installation

After installing the lolcommits gem, install this plugin with:

$ gem install lolcommits-twitter

Next configure the plugin to authenticate with Twitter and set tweeting options.

$ lolcommits --config -p twitter
# set enabled to `true` (then set your own options or choose the defaults)

Configuration

The following options are available:

  • prefix
  • suffix (default: #lolcommits)
  • auto-open tweet url?

You can always reconfigure the plugin without having to re-authenicate with Twitter.

To disable - set enabled: false and you can always revoke access to your twitter account here.

Development

Check out this repo and run bin/setup, to install all dependencies and generate docs. Run bundle exec rake to run all tests and generate a coverage report.

You can also run bin/console for an interactive prompt that will allow you to experiment with the gem code.

Tests

MiniTest is used for testing. Run the test suite with:

$ rake test

Docs

Generate docs for this gem with:

$ rake rdoc

Troubles?

If you think something is broken or missing, please raise a new issue. Take a moment to check it hasn't been raised in the past (and possibly closed).

Contributing

Bug reports and pull requests are welcome on GitHub.

When submitting pull requests, remember to add tests covering any new behaviour, and ensure all tests are passing on Travis CI. Read the contributing guidelines for more details.

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct. See here for more details.

License

The gem is available as open source under the terms of LGPL-3.