Skip to content
This repository has been archived by the owner on Sep 10, 2022. It is now read-only.

Bug Sub Bot

Jump to bottom
Aaron Graubert edited this page Nov 13, 2018 · 3 revisions

Bugs

This sub-bot adds utilities for bug tracking and management. To enable this suite, call EnableBugs on a CoreBot or pass EnableBugs to CoreBot.EnableAll.

This suite can also be useful for managing user feedback or generic issue tracking

Channels

This suite reserves the bugs channel reference

Commands

  • !bug <feedback or bug report ...> : Opens a new ticket with the feedback

    The message body (excluding '!bug') is reformatted as an issue and sent the bugs channel. This report becomes both the initial issue title, and also the first comment on the issue. The issue status starts as 'Pending' and only the command user is initially subscribed. If the bot is configured to do so, it will also drop a mention for a role which is expected to handle open issues

  • !thread <issue ID> : Loads and displays the full comment thread for a bug

  • !comment <issue ID> <Comments ...> : Adds comments to the issue

    A message will be posted containing the new comments will be posted. The message includes the issue ID, the current status, mentions for all users listening to the issue, the current issue title, and the new comment. Sending a comment does not automatically subscribe to the issue. Users with permissions to use this command may comment on any issue

  • !bug:status <issue ID> <New issue status> : Sets the issue's status

    Changes the status of the issue. A message will be posted indicating that the status has been changed. The message will include the issue ID, the new status, mentions for all users listening to the issue, and the current issue title

  • !bug:label <issue ID> <New issue label> : Sets the issue label

    Changes the title of the issue. A message will be posted indicating that the issue title has been changed. The message will include the issue ID, the current issue status, mentions for all users listening to the issue, the old issue title, and the new issue title

  • !bug:user <issue ID> <User reference> : Subscribes a user to an issue

    Adds the given user to the list of users to notify whenever an the given issue is changed. The bot will also DM the user to indicate that they have been subscribed and how to unsubscribe

  • !bug:unsubscribe <issue ID> : Unsubscribes from an issue

    Removes the command user from the given issue. If the user was the author of the issue, they cannot unsubscribe

Examples

  • A bug message !bug Something didn't work gets formatted as a bug:
New issue reported: {optional mention for a target role}
[{issue ID}] [Pending] @{author's mention} : Something didn't work
Clone this wiki locally