kylefang/probot.github.io
1
0
Fork 0
mirror of https://github.com/zhigang1992/probot.github.io.git synced 2026-01-12 22:49:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #216 from boyney123/patch-1

Browse Source 
Added auto-comment app to the repo
This commit is contained in:
Bex Warner
2018-07-25 11:28:06 -07:00
committed by GitHub
parent b3c3a7ee8e 4014eca56d
commit 05e6ac0d9e
1 changed files with 39 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
_apps/auto-comment.md Normal file
View File

@@ -0,0 +1,39 @@
---
title: Auto-comment
description: Comments on new issues and pull requests based on your configuration.
slug: auto-comment
screenshots:
- https://avatars3.githubusercontent.com/in/14394?s=88&v=4
authors: [ boyney123 ]
repository: boyney123/auto-comment
host: https://auto-comment.now.sh
---
## 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. |