GithubHelp home page GithubHelp logo

plan-b-ot's Introduction

Plan-B-ot

Plan-B-ot is an integration for Mattermost and slack which allows for Scrum Planning Poker inside the Mattermost or slack chat.

Plan-B-ot is written in go. Mattermost is an open source project: Mattermost on GitHub.

Usage

In a channel, use the slash command (see setup) to interact with the bot. If your slash command is called /planbot, you can issue the following commands:

/planbot task <your taskname>

Creates a new task with zero votes and the given name

/planbot vote <your vote>

Sets your vote on the current task. If you had a vote before, it gets overriden by the new vote.

/planbot results

Orders plan-b-ot to print all the voting results in the specified channel (see setup).

Setup

Mattermost/Slack

You need to setup two integrations: a slach command and an incoming web hook

Setup a slash command so users can interact with plan-b-ot:

  • Create a new slash command integration for your team.
  • Pick the command you want to use, e.g. planbot.
  • Specify the URL where your plan-b-ot will be running. If your server is reachable at example.com, your port is 8786, and your route is /planbot: then set this to example.com:8786/planbot. See also bot setup.
  • Method is POST.
  • Token: you need the token for the bot setup.

Setup an incoming web hook so plan-b-ot can post to your channel:

  • Create a new incoming web hook for your team.
  • Set the channel that you want plan-b-ot to post to.
  • Webhook URL: you need the webhook URL for the bot setup.

Bot

Copy config.json.example to config.json. Edit the contents of config.json to setup your plan-b-ot:

  • Port: The port on which plan-b-ot listens.
  • Route: The URL route for plan-b-ot.
  • Token: the token from the Mattermost/slack setup (slash command).
  • Webhook URL: The webhook URL from the Mattermost/slack setup (incoming web hook on Mattermost's/'slack's side).

Run plan-b-ot. Now the server is running and waiting for input from Mattermost/slack.

Contributions

Contributions are always welcome and do not have to be in a specific format.

Simply create a pull request on GitHub.

plan-b-ot's People

Contributors

schemar avatar

Stargazers

Ben Schumacher avatar Volkan Jacobsen avatar  avatar Bryan "BJ" Hoffpauir avatar Bulletninja avatar Jamie Wright avatar

Watchers

James Cloos avatar  avatar Ben Schumacher avatar

plan-b-ot's Issues

not working

Hi, I understend what you not working this is plugin but maybe you have idea:
if I use postman in request answer - "Please define something to do afte the slash command. E.g. /planbot task T54"
but if I use mattermost or curl-request answer - "Invalid token in slashcommand setup!"

Token loyal, verified through postman

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.