pairing-bot
v1.0.1
Published
A bot to track pairing from git commit, post stats and do suggestions.
Downloads
4
Maintainers
Readme
PairingBot
Slack bot to track pairing stats of agile pair programming team via git commits.
Bot integration details
- Create a slack custom integration for the bot (Slack Bot).
- Start the application with slack bot token.
- Invite the
PairingBot
to commit channel which is configured with incoming webhook from git. PairingBot
listens to message from git webhooks and track pairing stats from commit message.- Acceptable commit message samples
[StoryCardNumber] [Person1/Person2] commit message description
[StoryCardNumber] [Person1|Person2] commit message description
[StoryCardNumber] [Person1] commit message description
[Person1/Person2] commit message description
Person1/Person2: commit message description
Person1/Person2 - commit message description
- Get pairing information with the message
pairing stats?
as direct_message or with direct_mention to@PairingBot
. - Creare your team members list with
set member count
andadd member
commands. - You can also do manual update to pairing matrix for the day with
add solo
andadd pair
commands. - Works right out of the box, just keep calm and do pair programming.
Supported messages
hello, hi
list members
set member count <count>
add member <name>
remove member <name>
add solo <name>
add pair <name1,name2>
pairing stats?
missing stats?
notify pairing stats at <time>
notify missing stats at <time>
deactivate pairing stats notification
deactivate missing stats notification
uptime, who are you?
bye, see you later, tata, ciao, adieu
Accepted time formats:
( hh:mm
/ h
/ h.mm
/ hpm
/ h:mm a
/ h:mm a
/ h.mm am
/ h.mm A
/ hh:mm a.m.
/ h:mma
)
Install and Setup instructions
After cloning the repository and running npm install
or yarn install
inside, you can use the following command to start the bot.
token=<slack-token> <npm start / yarn start>
Pull requests are welcome!
Future extenstions
- Interactive conversations
- Graphical reports
- Pair switching reminders
License
MIT