A Lita handler to manage and automate daily standup meetings
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
locales
spec
templates
.gitignore
.travis.yml
Gemfile
README.md
Rakefile
lita-standup.gemspec

README.md

lita-standup

Build Status Coverage Status Gem Version

Lita-standup is a handler for Lita, meant to automate the process of the daily standup, and help teams collaborate.

Installation

Add lita-standup to your Lita instance's Gemfile:

gem "lita-standup"

Configuration

There's a lot here to configure. Add the following to your lita_config.rb and interpolate your credentials as needed.

Lita.configure do |config|

  # General settings
  config.handlers.standup.time_to_respond =           60  # type: Integer, default: 60 (minutes)
  config.handlers.standup.summary_email_recipients =  ['you@company.com', 'me@company.com'] # type: Array, required: true
  config.handlers.standup.name_of_auth_group =        :standup_participants   # type: Symbol, required: true

  ## SMTP Mailer settings
  config.handlers.standup.address =              'smtp.gmail.com' # type: String, required: true
  config.handlers.standup.port =                 587              # type: Integer, required: true
  config.handlers.standup.domain =               'your.host.name' # type: String, required: true
  config.handlers.standup.user_name =            'xxxxxxxxxx'     # type: String, required: true
  config.handlers.standup.password =             'xxxxxxxxxx'     # type: String, required: true
  config.handlers.standup.authentication =       'plain'          # type: String, required: true
  config.handlers.standup.enable_starttls_auto = true             # type: true || false, required: true

end

Usage

After you're properly configured, manage the auth groups you'll need to use this gem. Add yourself (or whoever else will start the standup) to the auth group :standup_admins and all participants to the auth group :standup_participants (unless you overrode this default in the config.)

To start the standup, give Lita the command Lita: start standup now.

You'll get a private message asking for your answer. Reply in the typical format (using numbers and colons) with 1: things you worked on yesterday, 2: things you'll be doing today, and 3: anything that's blocking you. Example :Lita: standup response 1: Finished this gem. 2: Make these docs a little better. 3: Wife is making cookies and it's hard to focus.

After the time_to_respond has elapsed, Lita will compile an email of the responses and send it to all the people in summary_email_recipients.

Bugs, Comments, feature requests

Please open an issue if you have anything to add.

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.