Approver Guide Documentation (#4373)

Co-authored-by: ReenigneArcher <[email protected]>
LizardByte · Jun 9, 2024 · d6d7dbb · d6d7dbb
1 parent e130d15
commit d6d7dbb
Show file tree

Hide file tree

Showing 7 changed files with 336 additions and 0 deletions.
diff --git a/docs/Approver_Guide.md b/docs/Approver_Guide.md
@@ -0,0 +1,91 @@
+# Approver Guide
+
+The following guide is meant for authorized Themerr approvers to use when approving theme submissions.
+
+## Process
+
+1. Open the issue on GitHub
+2. Inspect the issue title
+
+    - It should have the theme type in brackets.
+
+      - Valid types are "MOVIE", "MOVIE COLLECTION", "TV SHOW", "GAME", "GAME COLLECTION", "GAME FRANCHISE"
+
+    - The title of the item should follow it. If it is a Movie, TV Show, or Game, it will have the year in parenthesis.
+      Collections and Franchises will not have the year.
+
+3. Check if the issue has an exception
+
+    - An exception is indicated a couple ways:
+
+      - First is an exception comment
+
+        ![exception1](../docs/images/exception1.png)
+
+      - Second is a label that is added to the issue
+
+        ![exception2](../docs/images/exception2.png)
+
+    - If there are exceptions, we cannot add the theme.
+      Usually it's due to a regional block or age restriction on the video they submitted.
+      We need to direct the user to correct it by editing their original submission.
+
+4. Check if the issue is a duplicate submission
+
+    - A duplicate submission is indicated by a label:
+
+      ![duplicate](../docs/images/duplicate.png)
+
+    - Duplicate submissions modify themes currently in the database and need to be investigated with more scrutiny as we
+      don't want to accidentally overwrite a good theme with a lower quality theme.
+    - If an issue is marked as a duplicate, check the reason for the theme change in the user's submission, then determine
+      if the theme is better than the present one and meets our criteria for theme submissions.
+
+  > [!NOTE]
+  > If there is no reason given, the issue can be closed.
+
+5. Understand the contents of the comment from LizardByte-Bot
+
+    Specifically check the git diff.
+
+    - [okay.diff](../docs/references/okay.diff) is an example of one that is okay to add.
+      Basically, if there are new files added, this is a good sign! Lots of green is good!
+    - [do_not_add.diff](../docs/references/do_not_add.diff) is an example of one that is not okay to add.
+      The `youtube_theme_url` did not change... so basically they have submitted an edit to an item already in the library,
+      but they left the theme the same as the one we already have.
+      In this case, the bot will automatically flag this and close the issue.
+
+6. Watch/listen to the theme on youtube
+
+    - This portion comes down to human judgement, but the [Theme Guidelines](../docs/Theme_Guidelines.md) should be
+      referenced for precise rules when deciding.
+    - Typically when examining a theme, we set the computer to about 50% volume then right-click and open the theme in an
+      incognito window (so google doesn't recommend stuff based on every theme that's reviewed).
+
+7. Approve the theme
+
+    - First, make sure the latest bot comment matches the latest edit of the issue body (it might take a few minutes,
+      depending on how busy the GitHub activity is in our org at the time).
+    - To approve the theme, comment `@LizardByte-bot approve`. This will initiate a bot workflow where it will add the
+      `approve-queue` label. Once the issue comes to the front of the queue, the bot will run the checks again, then it
+      will add the theme to the database (assuming it passes everything).
+
+  > [!WARNING]
+  > Try to avoid approving any themes when a scheduled update is running.
+    You can check for that [here](https://github.com/LizardByte/ThemerrDB/actions/workflows/update-pages.yml?query=event%3Aschedule).
+    It runs at 12:00 UTC daily.
+
+## Helpful Tools
+
+- If you have a question or suggestion for a theme submission, place your comment, then add the `question` label to mark the issue.
+
+> [!NOTE]
+> If a user fails to answer your question after about a week or longer, you can proceed how you think best with the theme.
+
+- A youtube URL in a user submission can be edited by commenting `@LizardByte-bot edit {youtube_url}`.
+  This will replace the youtube URL and run the workflow to check the new URL.
+- A bot workflow to check a theme can be manually initiated by first removing, then adding the `request-theme` label.
+- The `approve-queue` label can be manually added to add an issue to the bot approval queue.
+
+> [!NOTE]
+> These labels should typically not need to be manually added, but they are helpful for troubleshooting.
diff --git a/docs/images/approver_guide.png b/docs/images/approver_guide.png
diff --git a/docs/images/duplicate.png b/docs/images/duplicate.png
diff --git a/docs/images/exception1.png b/docs/images/exception1.png
diff --git a/docs/images/exception2.png b/docs/images/exception2.png
diff --git a/docs/references/do_not_add.diff b/docs/references/do_not_add.diff
@@ -0,0 +1,44 @@
+diff --git a/movies/contributors.json b/movies/contributors.json
+index b64780880..53702fe76 100644
+--- a/movies/contributors.json
++++ b/movies/contributors.json
+@@ -23,6 +23,10 @@
+         "items_added": 41,
+         "items_edited": 1
+     },
++    "26876994": {
++        "items_added": 0,
++        "items_edited": 1
++    },
+     "28462047": {
+         "items_added": 4,
+         "items_edited": 0
+diff --git a/movies/imdb/tt2906216.json b/movies/imdb/tt2906216.json
+index da7408831..c14996f60 100644
+--- a/movies/imdb/tt2906216.json
++++ b/movies/imdb/tt2906216.json
+@@ -67,7 +67,7 @@
+     "vote_count": 2113,
+     "youtube_theme_added": 1683499234,
+     "youtube_theme_added_by": "88998541",
+-    "youtube_theme_edited": 1683499234,
+-    "youtube_theme_edited_by": "88998541",
++    "youtube_theme_edited": 1692643732,
++    "youtube_theme_edited_by": "26876994",
+     "youtube_theme_url": "https://www.youtube.com/watch?v=f2k1JjnY0dQ"
+ }
+\ No newline at end of file
+diff --git a/movies/themoviedb/493529.json b/movies/themoviedb/493529.json
+index da7408831..c14996f60 100644
+--- a/movies/themoviedb/493529.json
++++ b/movies/themoviedb/493529.json
+@@ -67,7 +67,7 @@
+     "vote_count": 2113,
+     "youtube_theme_added": 1683499234,
+     "youtube_theme_added_by": "88998541",
+-    "youtube_theme_edited": 1683499234,
+-    "youtube_theme_edited_by": "88998541",
++    "youtube_theme_edited": 1692643732,
++    "youtube_theme_edited_by": "26876994",
+     "youtube_theme_url": "https://www.youtube.com/watch?v=f2k1JjnY0dQ"
+ }
diff --git a/docs/references/okay.diff b/docs/references/okay.diff
@@ -0,0 +1,201 @@
+diff --git a/movie_collections/contributors.json b/movie_collections/contributors.json
+index dbb142d00..197a4f6ed 100644
+--- a/movie_collections/contributors.json
++++ b/movie_collections/contributors.json
+@@ -4,7 +4,7 @@
+         "items_edited": 0
+     },
+     "88998541": {
+-        "items_added": 7,
++        "items_added": 8,
+         "items_edited": 0
+     }
+ }
+\ No newline at end of file
+diff --git a/movie_collections/themoviedb/87359.json b/movie_collections/themoviedb/87359.json
+new file mode 100644
+index 000000000..75f22fa0f
+--- /dev/null
++++ b/movie_collections/themoviedb/87359.json
+@@ -0,0 +1,180 @@
++{
++    "backdrop_path": "/jYl0UuJFcmhymv9ZNO14lPLDY1Z.jpg",
++    "id": 87359,
++    "name": "Mission: Impossible Collection",
++    "overview": "Mission: Impossible is a series of a secret agent thriller films based on the popular television series. They chronicle the missions of a team of secret government agents known as the Impossible Missions Force (IMF) under the leadership of agent Ethan Hunt.",
++    "parts": [
++        {
++            "adult": false,
++            "backdrop_path": "/pbaAkR1FDvgndTVFgGRIzf9o49r.jpg",
++            "genre_ids": [
++                12,
++                28,
++                53
++            ],
++            "id": 954,
++            "media_type": "movie",
++            "original_language": "en",
++            "original_title": "Mission: Impossible",
++            "overview": "When Ethan Hunt, the leader of a crack espionage team whose perilous operation has gone awry with no explanation, discovers that a mole has penetrated the CIA, he's surprised to learn that he's the No. 1 suspect. To clear his name, Hunt now must ferret out the real double agent and, in the process, even the score.",
++            "popularity": 68.499,
++            "poster_path": "/l5uxY5m5OInWpcExIpKG6AR3rgL.jpg",
++            "release_date": "1996-05-22",
++            "title": "Mission: Impossible",
++            "video": false,
++            "vote_average": 7.0,
++            "vote_count": 8007
++        },
++        {
++            "adult": false,
++            "backdrop_path": "/24DZfupDlhXeTchmcOkoGRhP5Vg.jpg",
++            "genre_ids": [
++                12,
++                28,
++                53
++            ],
++            "id": 955,
++            "media_type": "movie",
++            "original_language": "en",
++            "original_title": "Mission: Impossible II",
++            "overview": "With computer genius Luther Stickell at his side and a beautiful thief on his mind, agent Ethan Hunt races across Australia and Spain to stop a former IMF agent from unleashing a genetically engineered biological weapon called Chimera. This mission, should Hunt choose to accept it, plunges him into the center of an international crisis of terrifying magnitude.",
++            "popularity": 52.653,
++            "poster_path": "/7us8nE3ldE0gX2cziUz4tKg0Go0.jpg",
++            "release_date": "2000-05-24",
++            "title": "Mission: Impossible II",
++            "video": false,
++            "vote_average": 6.118,
++            "vote_count": 6051
++        },
++        {
++            "adult": false,
++            "backdrop_path": "/sjcPWJ5TXgFglsoixNxyZRyEUq3.jpg",
++            "genre_ids": [
++                12,
++                28,
++                53
++            ],
++            "id": 956,
++            "media_type": "movie",
++            "original_language": "en",
++            "original_title": "Mission: Impossible III",
++            "overview": "Retired from active duty, and training recruits for the Impossible Mission Force, agent Ethan Hunt faces the toughest foe of his career: Owen Davian, an international broker of arms and information, who is as cunning as he is ruthless. Davian emerges to threaten Hunt and all that he holds dear -- including the woman Hunt loves.",
++            "popularity": 65.405,
++            "poster_path": "/3VianLpu8hhmq4TTItKPaCtA5su.jpg",
++            "release_date": "2006-04-25",
++            "title": "Mission: Impossible III",
++            "video": false,
++            "vote_average": 6.724,
++            "vote_count": 6118
++        },
++        {
++            "adult": false,
++            "backdrop_path": "/ih4lZkUpmSE7AP3maymiO72xJ1z.jpg",
++            "genre_ids": [
++                28,
++                53,
++                12
++            ],
++            "id": 56292,
++            "media_type": "movie",
++            "original_language": "en",
++            "original_title": "Mission: Impossible - Ghost Protocol",
++            "overview": "Ethan Hunt and his team are racing against time to track down a dangerous terrorist named Hendricks, who has gained access to Russian nuclear launch codes and is planning a strike on the United States. An attempt to stop him ends in an explosion causing severe destruction to the Kremlin and the IMF to be implicated in the bombing, forcing the President to disavow them. No longer being aided by the government, Ethan and his team chase Hendricks around the globe, although they might still be too late to stop a disaster.",
++            "popularity": 71.345,
++            "poster_path": "/psiWp3VTjznfokmGQG9uqiiknQQ.jpg",
++            "release_date": "2011-12-07",
++            "title": "Mission: Impossible - Ghost Protocol",
++            "video": false,
++            "vote_average": 7.067,
++            "vote_count": 9139
++        },
++        {
++            "adult": false,
++            "backdrop_path": "/OrYq215ZYM75dBaHt6v7EHEyPz.jpg",
++            "genre_ids": [
++                28,
++                12
++            ],
++            "id": 177677,
++            "media_type": "movie",
++            "original_language": "en",
++            "original_title": "Mission: Impossible - Rogue Nation",
++            "overview": "Ethan and team take on their most impossible mission yet\u2014eradicating 'The Syndicate', an International and highly-skilled rogue organization committed to destroying the IMF.",
++            "popularity": 71.617,
++            "poster_path": "/jwqL7croP7JMVfz0l9o7V4yJsJO.jpg",
++            "release_date": "2015-07-23",
++            "title": "Mission: Impossible - Rogue Nation",
++            "video": false,
++            "vote_average": 7.188,
++            "vote_count": 8100
++        },
++        {
++            "adult": false,
++            "backdrop_path": "/aw4FOsWr2FY373nKSxbpNi3fz4F.jpg",
++            "genre_ids": [
++                28,
++                12
++            ],
++            "id": 353081,
++            "media_type": "movie",
++            "original_language": "en",
++            "original_title": "Mission: Impossible - Fallout",
++            "overview": "When an IMF mission ends badly, the world is faced with dire consequences. As Ethan Hunt takes it upon himself to fulfill his original briefing, the CIA begin to question his loyalty and his motives. The IMF team find themselves in a race against time, hunted by assassins while trying to prevent a global catastrophe.",
++            "popularity": 107.488,
++            "poster_path": "/AkJQpZp9WoNdj7pLYSj1L0RcMMN.jpg",
++            "release_date": "2018-07-13",
++            "title": "Mission: Impossible - Fallout",
++            "video": false,
++            "vote_average": 7.412,
++            "vote_count": 7460
++        },
++        {
++            "adult": false,
++            "backdrop_path": "/628Dep6AxEtDxjZoGP78TsOxYbK.jpg",
++            "genre_ids": [
++                28,
++                12,
++                53
++            ],
++            "id": 575264,
++            "media_type": "movie",
++            "original_language": "en",
++            "original_title": "Mission: Impossible - Dead Reckoning Part One",
++            "overview": "Ethan Hunt and his IMF team embark on their most dangerous mission yet: To track down a terrifying new weapon that threatens all of humanity before it falls into the wrong hands. With control of the future and the world's fate at stake and dark forces from Ethan's past closing in, a deadly race around the globe begins. Confronted by a mysterious, all-powerful enemy, Ethan must consider that nothing can matter more than his mission\u2014not even the lives of those he cares about most.",
++            "popularity": 446.208,
++            "poster_path": "/NNxYkU70HPurnNCSiCjYAmacwm.jpg",
++            "release_date": "2023-07-08",
++            "title": "Mission: Impossible - Dead Reckoning Part One",
++            "video": false,
++            "vote_average": 7.742,
++            "vote_count": 1042
++        },
++        {
++            "adult": false,
++            "backdrop_path": null,
++            "genre_ids": [
++                28,
++                12,
++                53
++            ],
++            "id": 575265,
++            "media_type": "movie",
++            "original_language": "en",
++            "original_title": "Mission: Impossible - Dead Reckoning Part Two",
++            "overview": "The eighth installment of the Mission: Impossible franchise.",
++            "popularity": 43.438,
++            "poster_path": "/l2fgb4JU0uLpWTaMFrxPqfQ94Kr.jpg",
++            "release_date": "2024-06-26",
++            "title": "Mission: Impossible - Dead Reckoning Part Two",
++            "video": false,
++            "vote_average": 0.0,
++            "vote_count": 0
++        }
++    ],
++    "poster_path": "/geEjCGfdmRAA1skBPwojcdvnZ8A.jpg",
++    "youtube_theme_added": 1692729345,
++    "youtube_theme_added_by": "88998541",
++    "youtube_theme_edited": 1692729345,
++    "youtube_theme_edited_by": "88998541",
++    "youtube_theme_url": "https://www.youtube.com/watch?v=XAYhNHhxN0A"
++}
+\ No newline at end of file