docs: add relevance config to readme

EresDevOrg · Jul 23, 2024 · 6f014f4 · 6f014f4
1 parent 16d6c61
commit 6f014f4
Showing 1 changed file with 93 additions and 79 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,13 @@
 # `@ubiquibot/conversation-rewards`
 
-This is intended to be the proper implementation of comment incentives, based on our learnings from the first go-around. 
+This is intended to be the proper implementation of comment incentives, based on our learnings from the first go-around.
 
-As of 28 February: test driven development to aggregate all necessary information based on a URL to an issue. 
-- pass in closed as complete issue URL and receive all the timeline events and activities of all humans who helped close the issue as complete. 
-- most importantly: this can inherit bot authentication and link pull requests to issues in private repositories. 
+As of 28 February: test driven development to aggregate all necessary information based on a URL to an issue.
 
-Be sure to review all `*.test.*` files for implementation details. 
+- pass in closed as complete issue URL and receive all the timeline events and activities of all humans who helped close the issue as complete.
+- most importantly: this can inherit bot authentication and link pull requests to issues in private repositories.
+
+Be sure to review all `*.test.*` files for implementation details.
 
 ## Data structure
 
@@ -36,8 +37,9 @@ Be sure to review all `*.test.*` files for implementation details.
           },
           "reward": 0.8,
           "relevance": 0.5
+        }
       }
-    }]
+    ]
   }
 }
 ```
@@ -48,81 +50,93 @@ Reward formula: `((count * wordValue) * (score * formattingMultiplier) * n) * re
 
 Here is a possible valid configuration to enable this plugin.
 
-
 ```yaml
 plugin: ubiquibot/conversation-rewards
 with:
-    evmNetworkId: 100
-    evmPrivateEncrypted: "encrypted-key"
-    erc20RewardToken: "0xe91D153E0b41518A2Ce8Dd3D7944Fa863463a97d"
-    dataCollection:
-      maxAttempts: 10
-      delayMs: 10000
-    incentives:
+  evmNetworkId: 100
+  evmPrivateEncrypted: "encrypted-key"
+  erc20RewardToken: "0xe91D153E0b41518A2Ce8Dd3D7944Fa863463a97d"
+  dataCollection:
+    maxAttempts: 10
+    delayMs: 10000
+  incentives:
+    enabled: true
+    requirePriceLabel: true
+    contentEvaluator:
+      enabled: true
+      multipliers:
+        - targets: [ISSUE, ISSUER, SPECIFICATION]
+          relevance: 1
+        - targets: [REVIEW, ISSUER, TASK]
+          relevance: 1
+        - targets: [REVIEW, ISSUER, COMMENTED]
+          relevance: 1
+        - targets: [REVIEW, ASSIGNEE, COMMENTED]
+          relevance: 1
+        - targets: [REVIEW, COLLABORATOR, COMMENTED]
+          relevance: 1
+        - targets: [REVIEW, CONTRIBUTOR, COMMENTED]
+          relevance: 1
+    userExtractor:
+      enabled: true
+      redeemTask: true
+    dataPurge:
+      enabled: true
+    formattingEvaluator:
+      enabled: true
+      scores:
+        br: 0
+        code: 1
+        p: 1
+        em: 0
+        img: 0
+        strong: 0
+        blockquote: 0
+        h1: 1
+        h2: 1
+        h3: 1
+        h4: 1
+        h5: 1
+        h6: 1
+        a: 1
+        li: 1
+        td: 1
+        hr: 0
+      multipliers:
+        - targets: [ISSUE, ISSUER, SPECIFICATION]
+          formattingMultiplier: 1
+          wordValue: 0.1
+        - targets: [ISSUE, ISSUER, COMMENTED]
+          formattingMultiplier: 1
+          wordValue: 0.2
+        - targets: [ISSUE, ASSIGNEE, COMMENTED]
+          formattingMultiplier: 0
+          wordValue: 0
+        - targets: [ISSUE, COLLABORATOR, COMMENTED]
+          formattingMultiplier: 1
+          wordValue: 0.1
+        - targets: [ISSUE, CONTRIBUTOR, COMMENTED]
+          formattingMultiplier: 0.25
+          wordValue: 0.1
+        - targets: [REVIEW, ISSUER, TASK]
+          formattingMultiplier: 0
+          wordValue: 0
+        - targets: [REVIEW, ISSUER, COMMENTED]
+          formattingMultiplier: 2
+          wordValue: 0.2
+        - targets: [REVIEW, ASSIGNEE, COMMENTED]
+          formattingMultiplier: 1
+          wordValue: 0.1
+        - targets: [REVIEW, COLLABORATOR, COMMENTED]
+          formattingMultiplier: 1
+          wordValue: 0.1
+        - targets: [REVIEW, CONTRIBUTOR, COMMENTED]
+          formattingMultiplier: 0.25
+          wordValue: 0.1
+    permitGeneration:
+      enabled: true
+    githubComment:
       enabled: true
-      requirePriceLabel: true
-      contentEvaluator:
-        enabled: true
-      userExtractor:
-        enabled: true
-        redeemTask: true
-      dataPurge:
-        enabled: true
-      formattingEvaluator:
-        enabled: true
-        scores:
-          br: 0
-          code: 1
-          p: 1
-          em: 0
-          img: 0
-          strong: 0
-          blockquote: 0
-          h1: 1
-          h2: 1
-          h3: 1
-          h4: 1
-          h5: 1
-          h6: 1
-          a: 1
-          li: 1
-          td: 1
-          hr: 0
-        multipliers:
-          - targets: [ ISSUE, ISSUER, SPECIFICATION ]
-            formattingMultiplier: 1
-            wordValue: 0.1
-          - targets: [ ISSUE, ISSUER, COMMENTED ]
-            formattingMultiplier: 1
-            wordValue: 0.2
-          - targets: [ ISSUE, ASSIGNEE, COMMENTED ]
-            formattingMultiplier: 0
-            wordValue: 0
-          - targets: [ ISSUE, COLLABORATOR, COMMENTED ]
-            formattingMultiplier: 1
-            wordValue: 0.1
-          - targets: [ ISSUE, CONTRIBUTOR, COMMENTED ]
-            formattingMultiplier: 0.25
-            wordValue: 0.1
-          - targets: [ REVIEW, ISSUER, TASK ]
-            formattingMultiplier: 0
-            wordValue: 0
-          - targets: [ REVIEW, ISSUER, COMMENTED ]
-            formattingMultiplier: 2
-            wordValue: 0.2
-          - targets: [ REVIEW, ASSIGNEE, COMMENTED ]
-            formattingMultiplier: 1
-            wordValue: 0.1
-          - targets: [ REVIEW, COLLABORATOR, COMMENTED ]
-            formattingMultiplier: 1
-            wordValue: 0.1
-          - targets: [ REVIEW, CONTRIBUTOR, COMMENTED ]
-            formattingMultiplier: 0.25
-            wordValue: 0.1
-      permitGeneration:
-        enabled: true
-      githubComment:
-        enabled: true
-        post: true
-        debug: false
+      post: true
+      debug: false
 ```