From 1f734a7d9fff97f9750aadd44e8b0ed92ebd2bd7 Mon Sep 17 00:00:00 2001 From: David Boyne Date: Mon, 16 Jul 2018 20:39:05 +0100 Subject: [PATCH 1/3] Added auto-comment app to the repo Added my new Probot app to the list. --- _apps/your-app-name.md | 57 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 _apps/your-app-name.md diff --git a/_apps/your-app-name.md b/_apps/your-app-name.md new file mode 100644 index 0000000..73782dd --- /dev/null +++ b/_apps/your-app-name.md @@ -0,0 +1,57 @@ +--- +# A human-friendly name of your listing +title: Auto-comment +# A short description of what your app does +description: Comments on new issues and pull requests based on your configuration. +# The slug of your hosted app on GitHub (https://github.com/apps/YOUR-SLUG) +slug: https://github.com/apps/auto-comment +# Include a few screenshots that show your app in action +screenshots: +- https://avatars3.githubusercontent.com/in/14394?s=88&v=4 +# The GitHub usernames of anyone who authored the app +authors: [ boyney123 ] +# The repository where the code is located +repository: https://github.com/boyney123/auto-comment +host: https://auto-comment.now.sh +--- + +

+ +

auto-comment

+

A GitHub App built with Probot that comments on new issues and pull requests based on your configuration.

+

Build Status + Codecov + MIT + +

+

+ +![todo](./example.png) + +## Usage + +Using **auto-comment** is simple. Once you've installed it in your repository you will need to setup your `./github/auto-comment.yml` file and **auto-comment** will do the rest. + +## Configuring for your project + +There are a couple of configuration options that you will need to setup depending on what you want. + +```yml +# Comment to a new issue. +issueOpened: > + Thank your for raising a issue. We will try and get back to you as soon as possible. + + Please make sure you have given us as much context as possible. + +pullRequestOpened: > + Thank your for raising your pull request. + + Please make sure you have followed our contributing guidelines. We will review it as soon as possible +``` + +### Available options + +| Name | Type | Description | Example of Usage | +| ----------------- | -------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| issueOpened | `string` | This will be the message when new issues are created. | Auto comments on new issues are a great way to give feedback to users or a way of telling users to make sure they provide as much context as possible. | +| pullRequestOpened | `string` | This will be the message when new pull requests are created. | Thank people for creating pull requests, give them links to your contributing guideline. | From bf655fecab765f245f018b36a9a9bef8e5fe79dd Mon Sep 17 00:00:00 2001 From: David Boyne Date: Mon, 23 Jul 2018 08:43:50 +0100 Subject: [PATCH 2/3] Update and rename your-app-name.md to auto-comment.md Also fixed issues with first PR. --- _apps/{your-app-name.md => auto-comment.md} | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) rename _apps/{your-app-name.md => auto-comment.md} (86%) diff --git a/_apps/your-app-name.md b/_apps/auto-comment.md similarity index 86% rename from _apps/your-app-name.md rename to _apps/auto-comment.md index 73782dd..04d1784 100644 --- a/_apps/your-app-name.md +++ b/_apps/auto-comment.md @@ -1,17 +1,11 @@ --- -# A human-friendly name of your listing title: Auto-comment -# A short description of what your app does description: Comments on new issues and pull requests based on your configuration. -# The slug of your hosted app on GitHub (https://github.com/apps/YOUR-SLUG) -slug: https://github.com/apps/auto-comment -# Include a few screenshots that show your app in action +slug: auto-comment screenshots: - https://avatars3.githubusercontent.com/in/14394?s=88&v=4 -# The GitHub usernames of anyone who authored the app authors: [ boyney123 ] -# The repository where the code is located -repository: https://github.com/boyney123/auto-comment +repository: boyney123/auto-comment host: https://auto-comment.now.sh --- @@ -26,8 +20,6 @@ host: https://auto-comment.now.sh

-![todo](./example.png) - ## Usage Using **auto-comment** is simple. Once you've installed it in your repository you will need to setup your `./github/auto-comment.yml` file and **auto-comment** will do the rest. From 4014eca56d4c3acea0daf5b4093cda075ce0231c Mon Sep 17 00:00:00 2001 From: David Boyne Date: Wed, 25 Jul 2018 08:20:09 +0100 Subject: [PATCH 3/3] Update auto-comment.md Removed HTML in the markdown --- _apps/auto-comment.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/_apps/auto-comment.md b/_apps/auto-comment.md index 04d1784..6bd5737 100644 --- a/_apps/auto-comment.md +++ b/_apps/auto-comment.md @@ -9,16 +9,6 @@ repository: boyney123/auto-comment host: https://auto-comment.now.sh --- -

- -

auto-comment

-

A GitHub App built with Probot that comments on new issues and pull requests based on your configuration.

-

Build Status - Codecov - MIT - -

-

## Usage