mirror of
https://github.com/zhigang1992/probot.github.io.git
synced 2026-01-12 22:49:53 +08:00
3.0 KiB
3.0 KiB
title, description, slug, screenshots, authors, repository, host, stars, updated, installations, organizations
| title | description | slug | screenshots | authors | repository | host | stars | updated | installations | organizations | |||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Profanity | Marks/Censors Issues and Pull Requests containing offensive content. | profanity |
|
nickgarlis/probot-profanity | https://probot-profanity.now.sh | 8 | 2018-08-27 17:02:44 UTC | 11 |
|
Usage
- Configure the GitHub App
- Create
.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.
A .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 - https://github.com/nickgarlis/probot-profanity
# Language to detect profanity in.
# Choose one of the following: 'de', en', 'es', 'fr', 'it', 'nl', 'pt', 'ru'
language: 'en'
# Set to true to censor issues (defaults to false)
censor: false
# Placeholder to replace the letters of a forbidden word
placeholder: '*'
# A list of extra forbidden words. Set to `[]` to disable
extraWords: []
# A list of forbidden words to be ignored. Set to `[]` to disable
exemptWords: []
# 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 disable
exemptLabels: []
# 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 inappropriate
profanityLabel: inappropriate
# Comment to post when marking as profanity. Set to `false` to disable
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.
# 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 30
limitPerRun: 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