From b1c649c3b0b25dfebbbcc1211118efc9e598e873 Mon Sep 17 00:00:00 2001
From: yammes08 <111231042+yammes08@users.noreply.github.com>
Date: Mon, 14 Aug 2023 09:42:57 +0100
Subject: [PATCH] Added JSON scoring details

- Updated CONTRIBUTING.md with details about new JSON scoring requirements
---
 .github/CONTRIBUTING.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 0f3de6c8f..a2483233a 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -68,6 +68,25 @@ When doing a PR that is in-progress and not yet complete / ready for review or n
 - Provide a link to your regex example of your Custom Format using the following [Template](https://regex101.com/r/4DypIW/1).
 - When adding a RlsGrp to a Custom Format for whatever reason, please add in the PR why it's added/removed/moved.
 
+When adding scores
+
+- Scores must be added both as a single value under `trash_score` and as JSON objects under `trash_scores`, for example:
+
+```json
+{
+  "trash_id": "hashcode",
+  "trash_score": 50,
+  "trash_scores": {
+    "default": 50,
+    "some_other_profile": 100
+  },
+}
+```
+
+- This allows for Custom Formats to be assigned different scores for different profiles
+- The `trash_score` value must be the same as the `trash_scores` `default` value
+- The `trash_score` value is currently retained for compatibility reasons, but will eventually be removed
+
 When adding a regex test case
 
 - Replace the actual movie name with `Movie`.