From 91064cbed034c988f48fbc7f0c8c44a55a460de1 Mon Sep 17 00:00:00 2001 From: Aditya Agarwal Date: Sat, 11 Aug 2018 19:26:07 +0530 Subject: [PATCH 1/4] added background-check app --- _apps/background-check.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 _apps/background-check.md diff --git a/_apps/background-check.md b/_apps/background-check.md new file mode 100644 index 0000000..fb08911 --- /dev/null +++ b/_apps/background-check.md @@ -0,0 +1,17 @@ +--- +# A human-friendly name of your listing +title: Background Check +# A short description of what your app does +description: Performs a "background check" to identify users who have been toxic in the past, and shares their toxic activity in the maintainer’s repo. +# The slug of your hosted app on GitHub (https://github.com/apps/background-check) +slug: background-check +# Include a few screenshots that show your app in action +screenshots: +- https://raw.githubusercontent.com/probot/background-check/master/assets/demonstration.png +# The GitHub usernames of anyone who authored the app +authors: [ itaditya ] +# The repository where the code is located +repository: probot/background-check +# The address where this app is deployed +host: https://probot-background-check.herokuapp.com +--- From 9acf9ab3addc004fe383f178333b6def3b21a7d3 Mon Sep 17 00:00:00 2001 From: Aditya Agarwal Date: Sat, 11 Aug 2018 19:34:46 +0530 Subject: [PATCH 2/4] removed frontmatter --- _apps/background-check.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/_apps/background-check.md b/_apps/background-check.md index fb08911..56bc04c 100644 --- a/_apps/background-check.md +++ b/_apps/background-check.md @@ -1,17 +1,10 @@ --- -# A human-friendly name of your listing title: Background Check -# A short description of what your app does description: Performs a "background check" to identify users who have been toxic in the past, and shares their toxic activity in the maintainer’s repo. -# The slug of your hosted app on GitHub (https://github.com/apps/background-check) slug: background-check -# Include a few screenshots that show your app in action screenshots: - https://raw.githubusercontent.com/probot/background-check/master/assets/demonstration.png -# The GitHub usernames of anyone who authored the app authors: [ itaditya ] -# The repository where the code is located repository: probot/background-check -# The address where this app is deployed host: https://probot-background-check.herokuapp.com --- From 8d08bdf0c467920c69185c702f61bfeda00168a1 Mon Sep 17 00:00:00 2001 From: Aditya Agarwal Date: Mon, 13 Aug 2018 19:17:12 +0530 Subject: [PATCH 3/4] added more details --- _apps/background-check.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/_apps/background-check.md b/_apps/background-check.md index 56bc04c..770ee88 100644 --- a/_apps/background-check.md +++ b/_apps/background-check.md @@ -8,3 +8,12 @@ authors: [ itaditya ] repository: probot/background-check host: https://probot-background-check.herokuapp.com --- + +The bot listens to comments on repos in which the it is installed. When a new user comments, the bot fetches public comments of this user and run sentiment analyser on the comments. If 5 or more comments stand out as toxic, then the bot concludes that the user is of hostile background and an issue is opened for this user in `probot-background-check/{your-github-username}-discussions` private repo so that you and other maintainers can review these toxic comments and discuss whether or not you all want to allow this hostile user to participate in the community. + +## Setup the app + +* Install the app from [here](https://github.com/apps/background-check) in your repos. +* You'll receive an invitation to join a repo in `probot-background-check` org. Accept it. + +Simple as that. No config needed. From 1634352c4df794f3225f685ad8ed7db95990dc40 Mon Sep 17 00:00:00 2001 From: Brandon Keepers Date: Wed, 15 Aug 2018 12:44:49 -0400 Subject: [PATCH 4/4] Tweak description --- _apps/background-check.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_apps/background-check.md b/_apps/background-check.md index 770ee88..79f59fb 100644 --- a/_apps/background-check.md +++ b/_apps/background-check.md @@ -1,6 +1,6 @@ --- title: Background Check -description: Performs a "background check" to identify users who have been toxic in the past, and shares their toxic activity in the maintainer’s repo. +description: Notifies maintainers when new contributors who have been toxic in the past join the project slug: background-check screenshots: - https://raw.githubusercontent.com/probot/background-check/master/assets/demonstration.png @@ -9,7 +9,7 @@ repository: probot/background-check host: https://probot-background-check.herokuapp.com --- -The bot listens to comments on repos in which the it is installed. When a new user comments, the bot fetches public comments of this user and run sentiment analyser on the comments. If 5 or more comments stand out as toxic, then the bot concludes that the user is of hostile background and an issue is opened for this user in `probot-background-check/{your-github-username}-discussions` private repo so that you and other maintainers can review these toxic comments and discuss whether or not you all want to allow this hostile user to participate in the community. +When a new contributor comments on your repository, sentiment analysis is run on their recent public comments. If 5 or more comments stand out as toxic, then an issue is opened for this user in `probot-background-check/{your-github-username}-discussions` private repository so that you and other maintainers can review these toxic comments and discuss whether or not you all want to allow this hostile user to participate in the community. ## Setup the app