Quick Start

Installing the bot on a repository

To install the bot, go to our [page on GH Marketplace](https://github.com/apps/issue-classification-bot target="_blank") and click on Install.

Available commands

Interact with the Issue Classification Bot by using the following commands in the comments of a GitHub issues:

• /tdbot label: Automatically labels an issue using the ML model.
• /tdbot label <label>: Manually labels an issue with the specified label.
• /tdbot help: Displays this help message with command details.

Configuring (auto) labeling

Edit the Bot/config.json file to configure the bot's behavior:

• payload-type: Choose between:
  • "title": to set whether the bot's ML model should generate a label based on the title of the issue
  • "description": to set whether the bot's ML model should generate a label based on the description of the issue
  • "merged": to set whether the bot's ML model should generate a single label based on the title and the description of the issue
  • "both": to set whether the bot's ML model should generate two separate labels based on the title and the description of the issue
• auto-label: Boolean to set if the bot should automatically label new issues

Here is an example of a the command /tdbot label based on the issue description.

Configuring notifications

• send-emails: Boolean to set if the bot should send email notifications
• when-to-send: Choose between:
  • "label": to set whether the bot should send email notifications when an issue is labeled
  • "lingering": to set whether the bot should send email notifications when lingering issues have been identified in the repository
  • "all": to set whether the bot should send email notifications for all the above scenarios
• email-info: Configuration options for the email sender
  • which-labels: if the bot should send email notifications when it adds a label to the issue (by setting when-to-send to "label" or "all"), choose between:
    • "all": if the bot should send email notifications for all kinds of labels
    • "except": if the bot should send email notifications for all kinds of labels except the ones specified in except-labels
    • "specific": if the bot should send email notifications only for the labels specified in specific-labels
  • except-labels: the labels for which the bot does not send email notifications, specified as a list of strings: ["label1", "label2", ...]
  • specific-labels: the labels for which the bot sends email notifications, specified as a list of strings: ["label1", "label2", ...]
• recipients: the list of email addresses of contributors that should receive email notifications, specified as a list of strings: ["emailAddress1", "emailAddress2", ...]

Here is an example of an email sent by the bot based on a label.