Lolcommits Flowdock

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 lolcommits to a Flowdock flow (room) with the #lolcommits hashtag. They wll appear like this:

example commit

Requirements

Installation

After installing the lolcommits gem, install this plugin with:

$ gem install lolcommits-flowdock

Then configure to enable with:

$ lolcommits --config -p flowdock
# set enabled to `true`
# paste your Flowdock personal API token (from https://flowdock.com/account/tokens)
# set your Flowdock organization (tab to autocomplete)
# set the Flowdock flow to post messages to (tab to autocomplete)

That's it! Your next lolcommit will be posted as a new message to the flow. To disable uninstall this gem or use:

$ lolcommits --config -p flowdock
# and set enabled to `false`

Development

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

You can also run bin/console for an interactive prompt, allowing 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.