Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

behaviorbot/sentiment-bot

Open more actions menu

Repository files navigation

sentiment-bot

a GitHub App built with probot that replies to toxic comments with a maintainer designated reply and a link to the repo's code of conduct. It does so by taking data from a .github/config.yml.

screen shot 2017-08-15 at 8 51 38 am

You can tell from this example just how toxic I am 😜

Usage

  1. Install the bot on the intended repositories. The plugin requires the following Permissions and Events:
  • Issues: Read & Write
    • Issue Comment events
  • Organization members: Read (necessary to tag teams, i.e. cc/ @behaviorbot/moderators)
  1. Add a .github/config.yml file that contains the following:
# Configuration for sentiment-bot - https://github.com/behaviorbot/sentiment-bot

# *Required* toxicity threshold between 0 and .99 with the higher numbers being the most toxic
# Anything higher than this threshold will be marked as toxic and commented on
sentimentBotToxicityThreshold: .7

# *Required* Comment to reply with
sentimentBotReplyComment: >
  Please be sure to review the code of conduct and be respectful of other users. cc/ @hiimbex
  1. Be sure to check out the Perspective API before choosing your toxicity threshold to get a feel for what kind of comments would register at what toxicity threshold.

Setup

# Install dependencies
npm install

# Run the bot
npm start

See the probot deployment docs if you would like to run your own instance of this plugin.

About

Replies to toxic comments with a maintainer designated reply and a link to the repo's code of conduct

Topics

Resources

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages

Morty Proxy This is a proxified and sanitized view of the page, visit original site.