Skip to content

Commit

Permalink
Correct comment template config key in docs.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
lerebear committed Oct 10, 2023
1 parent 05cd0d4 commit 42d7f22
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion dist/config/default.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/config/default.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 42d7f22

Please sign in to comment.