Lolcommits Protonet

Gem Version Travis Build Status Test Coverage 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 allows you to push lolcommits to your Protonet box. The captured commit image is uploaded with a randomly generated message that includes the commit sha and branch name.

You should follow the API documentation found on your box under Help/"Protonet REST API" to get an API token.

Requirements

Installation

After installing the lolcommits gem, install this plugin with:

$ gem install lolcommits-protonet

Then configure to enable and set the api endpoint and token:

$ lolcommits --config -p protonet
# set enabled to `true`
# set the api endpoint and token

That's it! To disable uninstall this gem or:

$ lolcommits --config -p protonet
# 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 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.

Links