From 0a74da9b8ce6fed174fa3f896074362b5e2efb2e Mon Sep 17 00:00:00 2001 From: Rohit Sarkar Date: Wed, 18 Apr 2018 15:07:41 +0530 Subject: [PATCH] Add configuring details to readme --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6d839d6..738696d 100644 --- a/README.md +++ b/README.md @@ -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