Skip to content

Latest commit

 

History

History
131 lines (92 loc) · 4.81 KB

README.md

File metadata and controls

131 lines (92 loc) · 4.81 KB
Raw

Lolcommits Twitter

Gem Travis Depfu Maintainability Test Coverage

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, with some optional surrounding text) and the captured image. See the #lolcommits hash tag for some examples in the wild. You can also configure the plugin to auto-open the tweet in your default browser.

Requirements

Installation

After installing the lolcommits gem, install this plugin with:

$ gem install lolcommits-twitter

The configure the plugin to enable it and auth with Twitter

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

NOTE: if you enable this plugin on another repository you may want to copy the credentials from ~/.lolcommits/{your-repo}/config.yml (so Twitter does not de-authorize the connection).

Configuration

The following options are available:

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

You can always reconfigure the plugin later, to change these options without having to re-authenicate with Twitter.

To disable - set enabled: false and revoke plugin 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.

TODO

  • Support uploading lolcommit videos
  • Refactor Client to include Request/Response classes (see twitter gem approach)
  • Tests for Client lib classes
  • Tests for Plugin class (port tests from lolcommits)
  • Test running capture_ready method (stub with webmock?)
  • Correctly stub out launcher, or have it do nothing in tests
  • Update README
  • Check gem dependencies are correct

License

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

Links