https://github.com/behaviorbot/sentiment-bot

Replies to toxic comments with a maintainer designated reply and a link to the repo's code of conduct
https://github.com/behaviorbot/sentiment-bot

github-app probot probot-app

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/behaviorbot/sentiment-bot
• Owner: behaviorbot
• License: mit
• Created: 2017-06-19T21:23:16.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-09-23T20:23:00.000Z (over 3 years ago)
• Last Synced: 2024-09-27T08:02:24.623Z (4 months ago)
• Topics: github-app, probot, probot-app
• Language: JavaScript
• Homepage: https://github.com/apps/sentiment-bot
• Size: 647 KB
• Stars: 83
• Watchers: 5
• Forks: 12
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-list - sentiment-bot

README

        
# sentiment-bot

> a GitHub App built with [probot](https://github.com/probot/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`.



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)

2. Add a `.github/config.yml` file that contains the following:

```yml

# 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

```

3. Be sure to check out the [Perspective API](https://www.perspectiveapi.com/) 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](https://github.com/probot/probot/blob/master/docs/deployment.md) if you would like to run your own instance of this plugin.