twke

twke (pronounced twee-kee) is an extensible Campfire bot inspired by Hubot and created by the Librato team with the Scamp framework. His primary mission is to assist in the day-to-day DevOps activities of a team building and operating a SaaS platform.

Contributing to twke

twke's plugin system is modeled after Github-Services and creating a new plugin is extremely straightforward:

  1. Fork the project
  2. Start a feature branch
  3. Create a new file in /plugins called plugin_name.rb, using the following template:

    class Plugin::PluginName < Plugin
      def add_routes(rp)
        rp.route 'foo' do
          say 'bar'
        end
    
        rp.route 'hello' do
          say "Hello World!"
        end
      end
    end
    
  4. Commit and push until you are happy with your contribution

  5. Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

  6. Submit a pull request from your fork to josephruscio/twke

Colophon

twke is named after the ambuquad designated TWKE-4 who faithfully accompanied Buck Rogers in the 25th Century. His voice has been described as a cross between Yosemite Sam and Porky Pig, and he usually prefixed any speech with a low-pitched "bidi-bidi-bidi".

Copyright (c) 2011 Joseph Ruscio. See LICENSE.txt for further details.