Skip to content

Commit

Permalink
Add configuring details to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rsarky committed Apr 18, 2018
1 parent 98e7453 commit 0a74da9
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,33 @@ Now when someone references this issue in a pull request helpr will automaticall


**helpr** supports 3 labels :
* `pr-available`
* `pr-merged`
* `pr-rejected`
* `pr-available` when a new PR referencing an issue is opened.
* `pr-merged` when a PR referencing an issue is merged.
* `pr-rejected` when a PR referencing an issue is rejected.

When a PR for an issue is merged or rejected **helpr** will remove the `pr-available` label and add the respective merged or rejected label.

## Configuring

You can choose label names as per your liking :smile:

Add a `helpr` object in your `.github/config.yml` file (and make the file if you don't already have it) like this:

```yaml
helpr:
opened: 'insert-label-for-pr-opened-here'
merged: 'insert-label-for-pr-merged-here'
rejected: 'insert-label-for-pr-rejected-here'
```
Only override the ones that you want to change!
The defaults are:
```yaml
opened: 'pr-available'
merged: 'pr-merged'
rejected: 'pr-rejected'
```
## Setup
Expand Down

0 comments on commit 0a74da9

Please sign in to comment.