Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/behaviorbot/request-info
Requests more info from PRs/Issues with either the default title or a blank body
https://github.com/behaviorbot/request-info
github-app probot probot-app
Last synced: 2 months ago
JSON representation
Requests more info from PRs/Issues with either the default title or a blank body
- Host: GitHub
- URL: https://github.com/behaviorbot/request-info
- Owner: behaviorbot
- License: mit
- Created: 2017-06-26T16:32:50.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-02-21T13:08:05.000Z (almost 3 years ago)
- Last Synced: 2024-09-27T08:02:24.401Z (3 months ago)
- Topics: github-app, probot, probot-app
- Language: JavaScript
- Homepage: https://github.com/apps/request-info
- Size: 230 KB
- Stars: 114
- Watchers: 5
- Forks: 44
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-se-bots - Request Info - Requests more info on issues and pull requests with the default title or an empty body (Bots / Probot bots)
README
# request-info
> a GitHub App built with [probot](https://github.com/probot/probot) that requests more info from newly opened Pull Requests and Issues that contain either default titles or whose description is left blank. It does so by taking data from a `.github/config.yml`.
## Usage
1. Install the bot on the intended repositories. The plugin requires the following **Permissions and Events**:
- Pull requests: **Read & Write**
- [x] check the box for **Pull Request** events
- Issues: **Read & Write**
- [x] check the box for **Issue** events
2. Add a `.github/config.yml` file that contains the following:
```yml
# Configuration for request-info - https://github.com/behaviorbot/request-info
# *OPTIONAL* Comment to reply with
# Can be either a string :
requestInfoReplyComment: >
We would appreciate it if you could provide us with more info about this issue/pr!
# Or an array:
# requestInfoReplyComment:
# - Ah no! young blade! That was a trifle short!
# - Tell me more !
# - I am sure you can be more effusive
# *OPTIONAL* default titles to check against for lack of descriptiveness
# MUST BE ALL LOWERCASE
requestInfoDefaultTitles:
- update readme.md
- updates
# *OPTIONAL* Label to be added to Issues and Pull Requests with insufficient information given
requestInfoLabelToAdd: needs-more-info
# *OPTIONAL* Require Issues to contain more information than what is provided in the issue templates
# Will fail if the issue's body is equal to a provided template
checkIssueTemplate: true
# *OPTIONAL* Require Pull Requests to contain more information than what is provided in the PR template
# Will fail if the pull request's body is equal to the provided template
checkPullRequestTemplate: true
# *OPTIONAL* Only warn about insufficient information on these events type
# Keys must be lowercase. Valid values are 'issue' and 'pullRequest'
requestInfoOn:
pullRequest: true
issue: true
# *OPTIONAL* Add a list of people whose Issues/PRs will not be commented on
# keys must be GitHub usernames
requestInfoUserstoExclude:
- hiimbex
- bexo
```
3. If you prefer not to add a `.github/config.yml` file, you can simply install the bot and it would comment on issues and pull requests that have empty bodies, with the comment:
```
The maintainers of this repository would appreciate it if you could provide more information.
```
## Setup
```
# Install dependencies
npm install
# Run the bot
npm start
```
See [the probot deployment docs](https://github.com/probot/probot/blob/master/docs/deployment.md) if you would like to run your own instance of this plugin.