https://github.com/tailaiw/mind-your-language-action

A GitHub action that monitors PR/issue comments and warns senders who used offensive language.
https://github.com/tailaiw/mind-your-language-action

github-actions offensive-language profanity-check

Last synced: about 2 months ago
JSON representation

A GitHub action that monitors PR/issue comments and warns senders who used offensive language.

• Host: GitHub
• URL: https://github.com/tailaiw/mind-your-language-action
• Owner: tailaiw
• License: apache-2.0
• Created: 2020-03-05T15:42:48.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-04-11T01:38:10.000Z (over 4 years ago)
• Last Synced: 2024-05-12T16:31:58.750Z (7 months ago)
• Topics: github-actions, offensive-language, profanity-check
• Language: Shell
• Homepage:
• Size: 53.7 KB
• Stars: 17
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-actions - Mind Your Language Action - Detect offensive comments in issues and pull requests, and warn senders. (Community Resources / Utility)
• fucking-awesome-actions - Mind Your Language Action - Detect offensive comments in issues and pull requests, and warn senders. (Community Resources / Utility)
• awesome-workflows - Mind Your Language Action - Detect offensive comments in issues and pull requests, and warn senders. (Community Resources / Utility)

README

        
# Mind your language action

This action monitor comments to issues and pull requests, and remind the sender if offensive language is found.

## Example usage

Create the following workflow file `mind-your-language.yml` in the `.github/workflows/` directory of your repository:

```yml

name: Mind your language

on:

  issues:

    types:

      - opened

      - edited

  issue_comment:

    types:

      - created

      - edited

  pull_request_review_comment:

    types:

      - created

      - edited

jobs:

  echo_issue_comment:

    runs-on: ubuntu-latest

    name: profanity check

    steps:

      - name: Checkout

        uses: actions/checkout@v2

      - name: Profanity check step

        uses: tailaiw/[email protected]

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

## Workflow

Whenever a comment to an issue or pull request is created, the work flow will perform [profanity check](#profanity-check) against the comment text and take [reaction](#reaction) if offensive language is found.

### Profanity Check

I am currently using [profanity-check](https://github.com/vzhou842/profanity-check), a Python package of profanity detection based on machine learning, to determine whether a comment is offensive or not. It is not super powerful but is sensitive to obvious offensive language. I hope I may use some cutting-edge NLP algorithms to get better performance. I will create a separate repo to pursue better alternatives soon. If you are interested in it, stay tuned.

### Reaction

The reaction right now is an auto-reply by github-actions bot that mentions the sender of offensive comment. See the example as following.

![example.png](./example.png)

## Contributing

I'm a new developer of github action, so suggestion and help are more than welcome. Of course, "Mind your language" :smile: