# The badging-bot

## Command & Functionality

We integrate a GitHub app, the `@badging-bot,` to help us coordinate the workflow. The main function of the badging-bot is improving the efficiency of the reviewing process with some automated integration.&#x20;

**Some more functions of the badging-bot include:**

* Guiding applicants/reviewers
* Assigning reviewers for a submission
* Opening checklists for reviewers according to the type of event
* Checking current badge status
* Generating the final badge link
* Closing an application issue when an application is finalized

### Instances when the bot is triggered

Here is a mock submission illustrating the review process:

<https://github.com/badging/event-diversity-and-inclusion/issues/46>

This is what happened where the`@badging-bot` is triggered:

* **A new submission is created.** Once the issue of a new submission is successfully initiated, `@badging-bot` will do three things:
  * greet the applicant and provide guiding information ([see example](https://github.com/badging/event-diversity-and-inclusion/issues/46#issuecomment-674938374))
  * assign reviewers according to `reviewers.md`
  * open a checklist for each assigned reviewer ([see example](https://github.com/badging/event-diversity-and-inclusion/issues/46#issuecomment-674938396))
* **A command is typed in a review issue comment.** When someone creates an issue comment with a command, the bot will be triggered and respond in a new comment.&#x20;

### Commands

You can also interact with `@badging-bot`using a few commands.

#### 1. /result (Anyone)

* Type this command and only this command in an issue anytime during the review when you wish to check the current badge status.
* All roles are allowed to use this command.

```
/result
#show the current badge status
```

#### 2. /end (Moderators)

* Type this command and only this command in an issue when the review is at an end.
* Only moderators are allowed to use this command.

```
/end
#obtain the final badge and close the issue
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://handbook.chaoss.community/community-handbook/badging/the-badging-bot.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
