Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.94 KB

README.md

File metadata and controls

47 lines (32 loc) · 1.94 KB

Chekov (Check Off)

Chekov is a simple scrum bot for Slack. It first reminds users to update their JIRA tickets, then asks them what they worked on, what they will work on, and if they're on track to finish the sprint on time. If the last answer is no, a follow up question will be asked to give the reasons why.

A number of configuration options are available via environment variable; see env/example.env for more information.

Prerequisites

  • Node.js (tested with version 6 but others should work)
  • Administrative access to a Slack workspace for configuration
  • Docker (optional)

Setup

To use Chekov a bot must first be configured in your Slack workspace. More information on setting up Slack bots can be found here.

Once that is complete, create a new environment file by coping the example in the env folder. Add the generated token to it, and configure the other values as appropriate. Note that the bot must be invited to the desired posting channel with /invite @chekov (assuming you named your bot chekov in Slack, which you should; add a nice avatar of Walter Koenig while you're at it)

Finally run npm i to install Node.js dependencies.

Usage

To run the bot once, execute . env/your.env && npm start. It will go through its questions with the configured users, post the results, and then exit.

A Dockerfile is also provided. Execute docker build -t chekov . to build the image, and then run it with docker run --env-file env/your.env chekov.

Credits

This software was developed as an internal project at Votem Corp.

Votem bolsters trust, access, and transparency in elections with a core suite of products spanning voter registration, mobile and electronic ballot marking for military and overseas voters and voters with accessibility considerations, and election management systems focused on security and verifiable voting.

For more information, visit https://votem.com.