From 42d7f228d3781f630a3d9e01575ffe915b79b104 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9r=C3=A8?= Date: Tue, 10 Oct 2023 12:27:53 -0700 Subject: [PATCH] Correct comment template config key in docs. Note that although the key changed in the default config also, the default values from that config aren't actually used yet, so this doesn't actually change any functionality. --- README.md | 2 +- dist/config/default.yaml | 2 +- src/config/default.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 78be346..a542f68 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ commenting: # - threshold # - score # - category - scoreThresholdExceededCommentTemplate: | + commentTemplate: | 👋 @{{author}} this pull request exceeds the configured reviewability score threshold of {{threshold}}. Your actual score was {{score}}. # List of users for whom we should run this workflow diff --git a/dist/config/default.yaml b/dist/config/default.yaml index 689affc..93d7e22 100644 --- a/dist/config/default.yaml +++ b/dist/config/default.yaml @@ -23,7 +23,7 @@ commenting: # - threshold # - score # - category - scoreThresholdExceededCommentTemplate: | + commentTemplate: | 👋 @{{author}} this pull request exceeds the configured reviewability score threshold of {{threshold}}. Your actual score was {{score}}. [Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback. diff --git a/src/config/default.yaml b/src/config/default.yaml index 689affc..93d7e22 100644 --- a/src/config/default.yaml +++ b/src/config/default.yaml @@ -23,7 +23,7 @@ commenting: # - threshold # - score # - category - scoreThresholdExceededCommentTemplate: | + commentTemplate: | 👋 @{{author}} this pull request exceeds the configured reviewability score threshold of {{threshold}}. Your actual score was {{score}}. [Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.