chasebrignac/inclusive_bot

A bot that checks for unfriendly terminology in your repo

inclusiveBot

A GitHub App built with Probot that checks your pull requests (PR) for unfriendly terminology.

What this bot will do

Checks your PR for unfriendly, or not inclusive terminology. These words have been collected through talking to different engineers and asking them what they find unfriendly, not inclusive or not helpful terminology. The bot will let you know where these words occur by commenting on your PR.

What this bot won't do

This bot won't change your code for you. It won't correct your grammar. It won't suggest alternative terms to use, but that is something I want to add after I get some initial feedback.

How does it work?

When the inclusiveBot github app is installed on your repos any incoming PRs are checked for unfriendly terms. If one is found, a comment appears on the PR.

Get it running

You can install the app to run on your chosen repos here: https://github.com/apps/inclusivebot

Feedback

I would welcome any feedback you have on the project. You can open an issue via this repo, or drop me a slack message. Feedback can include constructive or helpful comments on the format of the code, the approach to the app or if you have come across any unfriendly or not inclusive words or terminology, you can submit a PR to add more words to those I have already researched or crowd sourced. You can submit any pull requests to add words to non_friendly.js. Thank you!

Development

If you'd like to take take the app a bit further you can fork, clone and get it running by following the below direction:

# Install dependencies
npm install

# Run the bot
npm start

License

ISC © 2019 Melanie Rogan