Accept comment threshold config at the top level

Also, for clarity group configs for labelling and commenting under
top-level keys.

README.md

@@ -36,15 +36,33 @@ This Action can be configured by specifying the `configuration-file` input. The
 An example configuration file looks like this:
 
 ```yaml
-# Whether or not to add a label to each pull request to indicate its assessed category
-applyCategoryLabels: true
+labeling:
 
-# The prefix to add to each category label that we apply.
-categoryLabelPrefix: "sizeup/"
+  # Whether or not to add a label to each pull request to indicate its assessed category
+  applyCategoryLabels: true
 
-# Whether or not to add a comment to each assessed pull request that exceeds
-# the recommended score threshold
-addCommentWhenScoreThresholdHasBeenExceeded: true
+  # The prefix to add to each category label that we apply.
+  categoryLabelPrefix: "sizeup/"
+
+commenting:
+
+  # Whether or not to comment on pull requests that exceed the configured score threshold
+  addCommentWhenScoreThresholdHasBeenExceeded: true
+
+  # The threshold above which we will add a comment to the assessed pull request.
+  scoreThreshold: 100
+
+  # The template for the comment that should be added to each pull request that
+  # exceeds the score threshold. Any of the following variables can be included
+  # in the template with surrounding curly braces (e.g. {{author}}) in order to
+  # interpolate a computed value into the comment:
+  #
+  #   - author
+  #   - threshold
+  #   - score
+  #   - category
+  scoreThresholdExceededCommentTemplate: |
+    👋 @{{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
 optIns:

__tests__/test-configuration.yaml

@@ -1,2 +1,4 @@
-applyCategoryLabels: false
-addCommentWhenScoreThresholdHasBeenExceeded: false
+labeling:
+  applyCategoryLabels: false
+commenting:
+  addCommentWhenScoreThresholdHasBeenExceeded: false

src/config/default.yaml

@@ -1,28 +1,34 @@
-# Whether or not to add a label to each pull request to indicate its assessed category
-applyCategoryLabels: true
+labeling:
 
-# The prefix to add to each category label that we apply.
-categoryLabelPrefix: "sizeup/"
+  # Whether or not to add a label to each pull request to indicate its assessed category
+  applyCategoryLabels: true
 
-# Whether or not to add a comment to each assessed pull request that exceeds
-# the configured score threshold.
-addCommentWhenScoreThresholdHasBeenExceeded: true
+  # The prefix to add to each category label that we apply.
+  categoryLabelPrefix: "sizeup/"
 
-# The template for the comment that should be added to each pull request that
-# exceeds the score threshold. Any of the following variables can be included
-# in the template with surrounding curly braces (e.g. {{author}}) in order to
-# interpolate a computed value into the comment:
-#
-#   - author
-#   - threshold
-#   - score
-#   - category
-scoreThresholdExceededCommentTemplate: |
-  👋 @{{author}} this pull request exceeds the configured reviewability score threshold of {{threshold}}. Your actual score was {{score}}.
+commenting:
 
-  [Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.
+  # Whether or not to comment on pull requests that exceed the configured score threshold
+  addCommentWhenScoreThresholdHasBeenExceeded: true
 
-  We recommend that you reduce the size of this PR by separating commits into stacked PRs.
+  # The threshold above which we will add a comment to the assessed pull request.
+  scoreThreshold: 100
+
+  # The template for the comment that should be added to each pull request that
+  # exceeds the score threshold. Any of the following variables can be included
+  # in the template with surrounding curly braces (e.g. {{author}}) in order to
+  # interpolate a computed value into the comment:
+  #
+  #   - author
+  #   - threshold
+  #   - score
+  #   - category
+  scoreThresholdExceededCommentTemplate: |
+    👋 @{{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.
+
+    We recommend that you reduce the size of this PR by separating commits into stacked PRs.
 
 # Configuration for how to evaluate pull requests.
 # This is of the same format that `sizeup` accepts directly.