Skip to content

shamkut/who_review_bot

Repository files navigation

About

who_review_bot - is a telegram bot aimed to help to define who is next to review

The bot suggests a review to the user, who has not reviewed for a long time

Prerequisites

The bot is prepared to be run in docker with docker-composer config. It means that you need both docker and docker-composer installed (for this way of using)

Installation & configuration

  1. git clone https://github.com/shamkut/who_review_bot.git
  2. rename example .\config\example.json to .\config\review.json
  3. edit review.json
    • set the value of your token to the attribute "token"
    • set the value of your language to the attribute "language", if you need
  4. run in you terminal command line $ docker-compose up -d
  5. have fun

Usage

Just add @who_review_me bot to the telegram group and type the backslash ("/") in message field to see the commands and its descriptions

The bot commands

  • /register - to register your user to the bot
  • /review, /r - to request a review of an article by the link
  • /unregister - to unregister user
  • /next - to show the next reviewer
  • /reviewers - to show all of the reviewers
  • /skip - to skip you or somebody to review for some days
    • 7 days skipping of you example:
      • /skip 7
    • 7 days skipping of Alex example:
      • /skip @alex 7
    • to stop skipping:
      • /skip 0
      • /skip @alex 0

Notes about language support

* If your language is english * you can just remove "language" and "dict" attributes from configuration
  • If your language is not english
    • you can set your own translations in the attribute "dict" (if you want)
    • if you do not want set translations, the bot will translate it with the google translator to your language

You can find two-letter language codes here

About

Telegram bot to assist with a cross review

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors