GithubHelp home page GithubHelp logo

michaeljolley / discord-guy-bot Goto Github PK

View Code? Open in Web Editor NEW
14.0 1.0 3.0 4.77 MB

A friendly Discord bot that helps server members use more inclusive language.

Home Page: https://guybot.app

License: MIT License

TypeScript 17.47% Dockerfile 0.85% CSS 77.21% HTML 4.47%
discord-bot diversity-in-tech inclusion hacktoberfest

discord-guy-bot's Introduction

Guy Bot

GitHub Workflow Status GitHub Invite to Discord

A friendly Discord bot that helps server members use more inclusive language.

How Does it Work?

When a user sends a message in a Discord channel that includes a word that is less than inclusive (i.e. "guys", "bros", "dudes", "chaps", etc.) in the first 10 or last 5 words, a guy-bot reaction is added to the message and a DM is sent to the author with the following:

Please bear in mind that the makeup of the {server name here} Discord server is very diverse, and some people feel excluded by the use of the term “{OFFENDING WORD}”. Maybe you could try using people, team, all, folks, everyone, or yall? Thanks for helping us make sure everyone feels welcome here.

If that user sends another message that includes a non-inclusive word in the first 10 or last 5 words within a month, that message will also receive a guy-bot reaction, but the message will be sent in the channel for everyone to see. Example:

{author mentioned here}, Please bear in mind that the makeup of the {server name here} Discord server is very diverse, and some people feel excluded by the use of the term “{OFFENDING WORD}”. Maybe you could try using people, team, all, folks, everyone, or yall? Thanks for helping us make sure everyone feels welcome here.

Development and Contributing

Interested in contributing? We ❤️ pull requests!

To make sure our community is safe for all, be sure to review and agree to our Code of Conduct. Then see the Contribution guidelines for more information.

Getting Help

We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either:

Attribution & Credits

Thanks to Luke Oliff. His Slack-based guys-bot repository was the inspiration for this project.

discord-guy-bot's People

Contributors

bendmyers avatar michaeljolley avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

discord-guy-bot's Issues

Change the areas of the message we review

Currently GuyBoy only reviews the first 10 words of a message for "guys." In the future, let's only look at the first and last 5 words.

The reasoning here is that you're more likely to use it in a non-inclusive way by opening or ending your message. "hey guys" or "what do you think guys?"

Should the bot flag whole words and not substrings of words?

Howdy! I noticed that this bot currently looks to see if an offending word is a substring of any of the words in the user's message (for instance, checking that firstWords.some(w => w.includes(f))) instead of something like firstWords.includes(f) or firstWords.find(w => w === f).

This could lead to some false positives such as:

  • ambrosia (bros)
  • salads (lads)
  • ballads (lads)
  • chapstick (chaps)

Should the bot check for full words, instead of substrings? If so, I'm happy to open up a PR with some changes!

Flag more words than just "guys"

There are multiple words that have the same impact as "guys." Let's modify the bot to flag them all.

Some examples include:

  • lads
  • bros
  • chaps

This should probably be a dynamic list we can add to without the need for redeployments in the future.

Allow phrases to be whitelisted

There are times where the use of words like "guys" is appropriate. In those instances, we'd like to not flag the message. An example would be discussion about the game "Fall Guys." Feel free to add other whitelist suggestions as comments.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.