desmondsanctity / badging-bot

A GitHub App that helps to coordinate the workflow of the DEI Badging, a peer-review program that is managed by the CHAOSS Community.

Badging-bot

The @badging-bot, is a GitHub App that helps to coordinate the workflow of the D&I Badging, a peer-review program that is managed by the CHAOSS Community. The main function of the badging-bot is to improve the efficiency of the review process of badging applications with some automated integration.

The badging-bot is built around the Journal of Open Source Software peer review system and is used to facilitate the application process for earning DEI event badges.

setting up local development environment

Seeting up the bot is as easy as navigating to your project folder in the terminal and running;

source <(curl -s https://raw.githubusercontent.com/badging/bot-scripts/main/install.sh)

Functions

The badging-bot is specifically intended to:

• Notify maintaineres about new applications
• Guide applicants/reviewers in the review process
• Assign reviewers for a submission
• Open checklists for reviewers according to the type of event
• Check current badge status
• Generate the final badge link
• Close an application issue when an application is finalized
• Update events table with reviewed events

Tasks

The badging bot can be used for a specific set of tasks:

• When 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)
  • Inform maintainer about new issue via slack using the integration
  • assign reviewers (In progress!)
  • open a checklist for each assigned reviewer (see example)
• When 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. This is generally used for generating badges
• When the state of the review changes The bot responds to state changes by managing labels and by opening or closing the issue.

Reporting Bugs and Issues

In case of any bugs, issues and glitches, feel free to open up a GitHub Issue or talk to the community on one of our communication channels.

How to contribute

The badging bot is a result of open source contributions. We don’t take any contribution for granted. We appreciate contributions to documentation, codebase and reviews. Our documentation is a section of the CHAOSS community handbook found here. For contributions to documentation, please submit a pull request to the community handbook repository. To contribute code to the badging-bot codebase, please read our contribution guidelines and submit a pull request to this repository.

Credits

• Aastha Bist - Original Developer of the Badging Bot
• Ore-Aruwaji Oloruntola - Developed Badging and CHAOSS translation tooling
• Xiaoya Xia Esther - Created the initial badging documentation
• Enoch Kaxada - Developing updates and fixes for the badging-bot
• Matt Cantu Snell - Founder of the DEI Badging initiative

License

ISC License