mirror of
https://github.com/charliegerard/safe-space.git
synced 2024-09-11 04:46:17 +03:00
Github action that checks the toxicity level of comments and PR reviews to help make repos safe spaces.
github-actionsjavascriptmachine-learningstarred-charliegerard-repostarred-repotensorflowtensorflowjstfjs
.github/workflows | ||
dist | ||
.gitignore | ||
action.yml | ||
demo.gif | ||
LICENSE.md | ||
package-lock.json | ||
package.json | ||
README.md |
Don't you know that you're toxic - Github action
Github action that uses machine learning to detect potential toxic comments added to PRs and issues so authors can have a chance to edit them and keep repos a safe space.
It uses the Tensorflow.js toxicity classification model.
It currently works when comments are posted on issues and PRs, as well as when pull request reviews are submitted.
Demo
How to use
If you do not have any Github action already set up in your repo, start by creating a .github/workflows folder.
Inside your workflows folder, create a new .yml file, for example main.yml
and copy the following lines:
on: [issue_comment, pull_request_review]
jobs:
toxic_check:
runs-on: ubuntu-latest
name: Don't you know that you're toxic
steps:
- uses: actions/checkout@v2
- name: Don't you know that you're toxic - action step
uses: charliegerard/dont-you-know-that-youre-toxic@master
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN
is required but two other parameters are optional:
message
- a custom message you'd like to display in the automatic commenttoxicity_threshold
- a float number between 0 and 1. It will used when loading the machine learning model. Its default value is 0.9.
on: [issue_comment, pull_request_review]
jobs:
toxic_check:
runs-on: ubuntu-latest
name: Don't you know that you're toxic
steps:
- uses: actions/checkout@v2
- name: Don't you know that you're toxic - action step
uses: charliegerard/dont-you-know-that-youre-toxic@master
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
message: "this is my custom message"
toxicity_threshold: 0.7