Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pastjean/scrumpolice

Slack & Golang - status meeting helper
https://github.com/pastjean/scrumpolice

Last synced: 2 months ago
JSON representation

Slack & Golang - status meeting helper

Awesome Lists containing this project

README

        

```
_ _
___ ___ _ __ _ _ _ __ ___ _ __ ___ | (_) ___ ___
/ __|/ __| '__| | | | '_ ` _ \| '_ \ / _ \| | |/ __/ _ \
\__ \ (__| | | |_| | | | | | | |_) | (_) | | | (_| __/
|___/\___|_| \__,_|_| |_| |_| .__/ \___/|_|_|\___\___|
|_|
```

[![Build Status](https://travis-ci.org/pastjean/scrumpolice.svg?branch=master)](https://travis-ci.org/pastjean/scrumpolice)
[![Go Report Card](https://goreportcard.com/badge/github.com/pastjean/scrumpolice)](https://goreportcard.com/report/github.com/pastjean/scrumpolice)

Scrum bot ask every member of your team for a scrum report then reports it to
your team's channel at a predefined time.

- [Jason Fried's - Status meetings are the scourge](https://m.signalvnoise.com/status-meetings-are-the-scourge-39f49267ca90) started all the fuzz.

# Usage

Create your configuration file:

```json
{
"timezone": "America/Montreal",
"teams": [
{
"channel": "themostaswesometeamchannel",
"name": "L337 team",
"members": [
"@gfreeman",
"@evance",
"@wbreen"
],
"split_report": true,
"question_sets": [
{
"questions": [
"What did you do yesterday?",
"What will you do today?",
"Are you being blocked by someone for a review? who ? why ?",
"How will you dominate the world"
],
"report_schedule_cron": "0 5 9 * * 1-5",
"first_reminder_limit": "-50m",
"last_reminder_limit": "-5m"
}
]
}
]
}
```

`split_report`: whether to post each scrum entry as a separate message or post all scrum entries in the same message.

Run the bot with a slack bot user token

```sh
SCRUMPOLICE_SLACK_TOKEN=xoxb-mytoken scrumpolice -config config.json
```

# Development

Have a working go environment (since 1.8 just install go) otherwise you need the
`$GOPATH` set and use that instead of `$HOME/go`.

```sh
go get github.com/pastjean/scrumpolice
cd $HOME/go/src/github.com/pastjean/scrumpolice
dep ensure
# Run it
SCRUMPOLICE_SLACK_TOKEN=xoxb-mytoken go run cmd/scrumpolice/scrumpolice.go -config config.example.json
```