From 69416cbc1ed4ba8d172eb3f46f197c1a09dee290 Mon Sep 17 00:00:00 2001 From: nickgarlis Date: Sun, 8 Apr 2018 12:44:43 +0300 Subject: [PATCH 1/4] Adds profanity --- _apps/profanity.md | 77 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 _apps/profanity.md diff --git a/_apps/profanity.md b/_apps/profanity.md new file mode 100644 index 0000000..1b0eb18 --- /dev/null +++ b/_apps/profanity.md @@ -0,0 +1,77 @@ +--- +title: Profanity +description: Marks/Censors Issues and Pull Requests containing offensive content. +slug: profanity +screenshots: +- https://user-images.githubusercontent.com/25513006/38316149-bc43b3c0-3832-11e8-8b13-53216b342027.png +- https://user-images.githubusercontent.com/25513006/38316166-c48f9eb8-3832-11e8-95a3-78773c7120a4.png +authors: [ nickgarlis ] +repository: nickgarlis/probot-profanity +host: https://probot-profanity.now.sh +--- + +## Usage + +1. **[Configure the GitHub App](https://github.com/apps/profanity)** +2. Create `.github/profanity.yml` based on the following template +3. It will start scanning for offensive issues and/or pull requests within an hour. + +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: + +```yml +# Configuration for probot-profanity - https://github.com/nickgarlis/probot-profanity + +# Set to true to censor issues (defaults to false) +censor: false + +# Placeholder to replace the letters of a forbidden word +placeholder: '*' + +# 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 +staleLabel: inappropriate + +# Comment to post when marking as stale. 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: +# daysUntilStale: 30 +# 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 +``` \ No newline at end of file From 1d9b73a728316143792664219381754faafc6f62 Mon Sep 17 00:00:00 2001 From: Nick Garlis Date: Fri, 11 May 2018 17:27:10 +0300 Subject: [PATCH 2/4] Update profanity.md --- _apps/profanity.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/_apps/profanity.md b/_apps/profanity.md index 1b0eb18..8f5540c 100644 --- a/_apps/profanity.md +++ b/_apps/profanity.md @@ -41,9 +41,9 @@ exemptProjects: false exemptMilestones: false # Label to use when marking as inappropriate -staleLabel: inappropriate +profanityLabel: inappropriate -# Comment to post when marking as stale. Set to `false` to disable +# Comment to post when marking as inappropriate. 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 @@ -65,7 +65,6 @@ limitPerRun: 30 # Optionally, specify configuration settings that are specific to just 'issues' or 'pulls': # pulls: -# daysUntilStale: 30 # markComment: > # This issue has been automatically marked as inappropriate because # it contains forbidden words. It will be closed if no further edit @@ -74,4 +73,4 @@ limitPerRun: 30 # issues: # exemptLabels: # - somelabel -``` \ No newline at end of file +``` From b8bdc864a885b611885340ec1a3e9629d3b99785 Mon Sep 17 00:00:00 2001 From: Nick Garlis Date: Tue, 22 May 2018 17:52:52 +0300 Subject: [PATCH 3/4] Update usage --- _apps/profanity.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_apps/profanity.md b/_apps/profanity.md index 8f5540c..2265190 100644 --- a/_apps/profanity.md +++ b/_apps/profanity.md @@ -14,7 +14,7 @@ host: https://probot-profanity.now.sh 1. **[Configure the GitHub App](https://github.com/apps/profanity)** 2. Create `.github/profanity.yml` based on the following template -3. It will start scanning for offensive issues and/or pull requests within an hour. +3. 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: From 4c8f7427be4af44e9cb357107a9b2bfb176006cc Mon Sep 17 00:00:00 2001 From: Nick Garlis Date: Wed, 18 Jul 2018 12:38:54 +0300 Subject: [PATCH 4/4] Update documentation --- _apps/profanity.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/_apps/profanity.md b/_apps/profanity.md index 2265190..3c5f849 100644 --- a/_apps/profanity.md +++ b/_apps/profanity.md @@ -21,12 +21,22 @@ A `.github/profanity.yml` file is required to enable the plugin. The file can be ```yml # 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 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 @@ -43,7 +53,7 @@ exemptMilestones: false # Label to use when marking as inappropriate profanityLabel: inappropriate -# Comment to post when marking as inappropriate. Set to `false` to disable +# 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