cybercog / telegram-devpoker-bot Goto Github PK

6.0 3.0 3.0 47 KB

Planning Poker (Scrum Poker) for Agile software development teams. The bot allows you to introduce a consensus-based, gamified technique of task estimating into Telegram group chats.

License: MIT License

Dockerfile 0.46% Python 98.53% Shell 1.01%

telegram telegram-bot chat-bot chat-bots planning-poker planning-poker-game scrum-poker telegram-bots collaboration estimating

telegram-devpoker-bot's Introduction

Telegram DevPoker Bot

Planning Poker (Scrum Poker) for Agile software development teams. The bot allows you to introduce a consensus-based, gamified technique of task estimating into Telegram group chats.

Usage

⚠️ Work in progress. Public bot may be offline until the first stable release.

Add @devpoker_bot to the group chat.

To start Planning Poker use /poker command. Add any description after the command to provide context.

Example:

/poker https://issue.tracker/TASK-123

Example with multiline description:

/poker https://issue.tracker/TASK-123
Design DevPoker bot keyboard layout

Only initiator can open cards or restart game at any moment.

Discussion phase

Discussion phase votes:

👍 — Ready to estimate
⁉️ — I have a questions or something to add
✂️ — Split task into subtasks
☠️️ — Cancel task (already done or not actual)
♾️ — Impossible to estimate or task cannot be completed
☕️ — I need a break

Estimation phase

Currently, there is only one sequence of numbers:

0.5, 1, 2, 3, 4, 5
6, 7, 8, 9, 10, 12
18, 24, 30, 36

Special cases:

❓ — Unsure how to estimate (out of context, never solved such tasks)

Self-hosted usage

Bot works on Python 3.6.

Run run.sh script with bot api token to start the Docker container.

You need to obtain own bot token from https://t.me/BotFather, then run:

DEVPOKER_BOT_API_TOKEN=11111424242:some-token ./run.sh

This command will create image and container devpoker-bot.

Bot uses SQLite database at host in ~/.devpoker_bot/devpoker_bot.db.

Credits

This project is inspired by the tg-planning-poker.

License

Telegram DevPoker Bot is open-sourced software licensed under the MIT license by Anton Komarev.

About CyberCog

CyberCog is a Social Unity of enthusiasts. Research the best solutions in product & software development is our passion.

telegram-devpoker-bot's People

Contributors

Stargazers

Watchers

Forkers

william3johnson ir0daytoday

telegram-devpoker-bot's Issues

Design messages

Add Devpoker bot to the Awesome list

https://github.com/telegram-bot-sdk/awesome-telegram-bots

Add game phases

Phases:

Initiating phase
Voting phase
Result phase

Initiating phase

ready to start
let's discuss
start game (initiator only)

Voting phase

points
special cases
restart (initiator only)
end game (initiator only)

Result phase

re-vote (clone procedure, hide keyboard of source procedure)

Move environment variables to .env file

Right now bot is running using shell command:

DEVPOKER_BOT_API_TOKEN=11111424242:some-token ./run.sh

Need to move DEVPOKER_BOT_API_TOKEN variable to .env file in project root directory. To make it run like:

./run.sh

Add action menu commands

help
poker
choose_deck

Render emoji card suites in desktop client

Card Suites emojis in desktop client are not working. Need to redesign icon rendering.

Send same message raises an API error

aiotg.bot.BotApiError: Bad Request: message is not modified: specified new message content and reply markup are exactly the same as a current content and reply markup of the message

Keep old game result on re-estimate click

Do not overwrite game data when re-estimation is clicked

Add created_at & updated_at timestamps to games

Normalize Facilitator in database

Need to store users in separate database table and pass only facilitator_user_id and player_user_id in game_session and game tables.

Improve naming

Make naming consistent.

Game — is a planning poker game. Game contains of game sessions. Each session belongs to a topic (issue/task).

Game session phases

discussion
estimation
resolution

Initiator operations

start_estimation
end_estimation
clear_votes
re_estimate

Callbacks

discussion-vote-click-{topic_message_id}-{vote}
estimation-vote-click-{topic_message_id}-{vote}
{operation}-click-{topic_message_id}
- start_estimation-click-{topic_message_id}
- end_estimation-click-{topic_message_id}
- clear_votes-click-{topic_message_id}
- re_estimate-click-{topic_message_id}

Class types

Game
GameSession
GameRegistry
DiscussionVote
EstimationVote

Create Discord channel

Cancel session on discussion phase

Split game.py to classes

Blocked by:

Start using docker-compose

Need to start using docker-compose to run the Docker container without run.sh shell script.

Prevent game session actions after game ends

On game end:

hide all buttons in related game sessions
disable all callbacks in related game sessions

Update system message text on editing facilitator message text

When source message text is edited we should edit it bot's system messages with this facilitator_message_id.

Need to choose between implementations:

update all messages related to facilitator_message_id
update only active sessions related to facilitator_message_id

Need to update Game & GameSession system messages.

Game start
Game session attach
Game end
Game statistics

Planning Game Start

Command /game {game_name} starts game with provided name.

When game is starting, Bot sends a message:

Planning poker started: {game_name}

If {game_name} is empty — default name is (no game name).

If there is active game Bot should say that Game already started and you can't start a new one unless it's ended.

Planning Game Process

If Game in Chat is active — all Sessions will have game_id related to active Game.

If source message text is edited active Game message should be renamed as well.

Planning Game End

Command /game_end ends currently started Game.

When Game ends — Bot sends statistics:

Planning poker ended: {game_name}
Estimated topics count: {estimated_topics_count}
Canceled discussions count: {canceled_topics_count} (if count > 0)
- #16

Message should be sent with disable_web_page_preview=True.