Merge pull request #96 from probot/add-no-response-app

Add no-response app description
This commit is contained in:
Brandon Keepers
2017-11-11 08:55:29 -06:00
committed by GitHub

65
_apps/no-response.md Normal file
View File

@@ -0,0 +1,65 @@
---
title: No Response
description: Closes Issues where the author hasn't responded to a request for more information.
slug: no-response
screenshots:
- https://raw.githubusercontent.com/probot/no-response/master/docs/no-response-test.png
authors:
- lee-dohm
repository: probot/no-response
host: https://probot-no-response.herokuapp.com
---
Automatically closes Issues where the author hasn't responded to a request for more information.
## App Workflow
The intent of this app is to close issues that have not received a response to a maintainer's request for more information. Many times issues will be filed without enough information to be properly investigated. This allows maintainers to label an issue as requiring more information from the original author. If the information is not received in a timely manner, the issue will be closed. If the original author comes back and gives more information, the label is removed and the issue is reopened if necessary.
### Scheduled
Once per hour, it searches for issues that:
* Are open
* Have a label named the same as the `responseRequiredLabel` value in the configuration
* The `responseRequiredLabel` was applied more than `daysUntilClose` ago
For each issue found, it:
1. If `closeComment` is not `false`, posts the contents of `closeComment`
1. Closes the issue
### `issue_comment` Event
When an `issue_comment` event is received, if all of the following are true:
* The author of the comment is the original author of the issue
* The issue has a label named the same as the `responseRequiredLabel` value in the configuration
It will:
1. Remove the `responseRequiredLabel`
1. Reopen the issue if it was closed
## Usage
1. **[Configure the GitHub App](https://github.com/apps/no-response)**
2. Create `.github/no-response.yml`
A `.github/no-response.yml` file is required to enable the app. The file can be empty, or it can override any of these default settings:
```yml
# Configuration for probot-no-response - https://github.com/probot/no-response
# Number of days of inactivity before an Issue is closed for lack of response
daysUntilClose: 14
# Label requiring a response
responseRequiredLabel: more-information-needed
# Comment to post when closing an Issue for lack of response. Set to `false` to disable
closeComment: >
This issue has been automatically closed because there has been no response
to our request for more information from the original author. With only the
information that is currently in the issue, we don't have enough information
to take action. Please reach out if you have or find the answers we need so
that we can investigate further.
```