a GitHub App built with Probot that marks/censors Issues and Pull Requests containing offensive content.
Based on @bkeepers's stale bot.
- Configure the GitHub App
.github/profanity.ymlbased on the following template
- It will start scanning for offensive issues and/or pull requests within an hour and automatically censor/mark any new ones.
.github/profanity.yml file is required to enable the plugin. The file can be empty, or it can override any of these default settings:
# Configuration for probot-profanity -# Language to detect profanity in.# Choose one of the following: 'en', 'es'language: 'en'# Set to true to censor issues (defaults to false)censor: false# Placeholder to replace the letters of a forbidden wordplaceholder: '*'# A list of extra forbidden words. Set to `` to disableextraWords: # A list of forbidden words to be ignored. Set to `` to disableexemptWords: # Number of days of inactivity before an inappropriate Issue or Pull Request is closed.# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as inappropriate.daysUntilClose: 2# Issues or Pull Requests with these labels will never be considered inappropriate. Set to `` to disableexemptLabels: # Set to true to ignore issues in a project (defaults to false)exemptProjects: false# Set to true to ignore issues in a milestone (defaults to false)exemptMilestones: false# Label to use when marking as inappropriateprofanityLabel: inappropriate# Comment to post when marking as profanity. Set to `false` to disablemarkComment: >This issue has been automatically marked as inappropriate becauseit contains forbidden words. It will be closed if no further editoccurs. Thank you for your contributions.# Comment to post when removing the inappropriate label.# unmarkComment: ># Your comment here.# Comment to post when closing an inappropriate Issue or Pull Request.# closeComment: ># Your comment here.# Limit the number of actions per hour, from 1-30. Default is 30limitPerRun: 30# Limit to only `issues` or `pulls`# only: issues# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':# pulls:# markComment: ># This issue has been automatically marked as inappropriate because# it contains forbidden words. It will be closed if no further edit# occurs. Thank you for your contributions.# issues:# exemptLabels:# - somelabel
Why did only some issues and pull requests get marked as inappropriate?
To avoid triggering abuse prevention mechanisms on GitHub, only 30 issues and pull requests will be marked or closed per hour. If your repository has more than that, it will just take a few hours or days to mark them all.