From 824f59b8768b9c753df4ed8b2b602a3feb55e230 Mon Sep 17 00:00:00 2001 From: TRaSH Date: Mon, 26 Jun 2023 18:30:44 +0200 Subject: [PATCH 1/5] chore(backend): Change URL from personal to org - Changed: URL from personal to org --- .github/PULL_REQUEST_TEMPLATE.md | 6 +++--- docs/Bazarr/scripts/index.md | 2 +- docs/index.md | 10 +++++----- mkdocs.yml | 6 +++--- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ec0f5919d..c4fe7e39a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,10 +12,10 @@ Check all boxes as they are completed - [ ] Use github checklists. When solved, check the box and explain the answer. **Learning** -If you're adding a new Custom Format make sure you follow the [Radarr/Sonarr Custom Format (JSON) Guidelines](https://github.com/TRaSH-/Guides/blob/master/.github/CONTRIBUTING.md). +If you're adding a new Custom Format make sure you follow the [Radarr/Sonarr Custom Format (JSON) Guidelines](https://github.com/TRaSH-Guides/Guides/blob/master/.github/CONTRIBUTING.md). **Requirements** Check all boxes as they are completed -- [ ] These changes meet the standards for [contributing](https://github.com/TRaSH-/Guides/blob/master/.github/CONTRIBUTING.md). -- [ ] I have read the [code of conduct](https://github.com/TRaSH-/Guides/blob/master/.github/CODE_OF_CONDUCT.md). +- [ ] These changes meet the standards for [contributing](https://github.com/TRaSH-Guides/Guides/blob/master/.github/CONTRIBUTING.md). +- [ ] I have read the [code of conduct](https://github.com/TRaSH-Guides/Guides/blob/master/.github/CODE_OF_CONDUCT.md). diff --git a/docs/Bazarr/scripts/index.md b/docs/Bazarr/scripts/index.md index 1baaed6c7..659df7414 100644 --- a/docs/Bazarr/scripts/index.md +++ b/docs/Bazarr/scripts/index.md @@ -3,7 +3,7 @@ !!! note "" Here you will find a collection of Scripts you can use with Bazarr. - Most of them are provided by other users, if you got a script you want to share don't hesitate to create a [PR](https://github.com/TRaSH-/Guides/blob/master/.github/CONTRIBUTING.md) for it + Most of them are provided by other users, if you got a script you want to share don't hesitate to create a [PR](https://github.com/TRaSH-Guides/Guides/blob/master/.github/CONTRIBUTING.md) for it ## 2 to 3 language code diff --git a/docs/index.md b/docs/index.md index 75403a21f..fff655f54 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,10 +5,10 @@ # TRaSH-Guides [![Discord chat](https://img.shields.io/discord/492590071455940612?style=flat-square&color=4051B5&logo=discord){ .off-glb }](https://trash-guides.info/discord){:target="_blank" rel="noopener noreferrer"} -[![GitHub last commit](https://img.shields.io/github/last-commit/TRaSH-/Guides?color=4051B5&label=Last%20Update&style=flat-square){ .off-glb }](https://github.com/TRaSH-/Guides/commits/master){:target="_blank" rel="noopener noreferrer"} -[![GitHub contributors](https://img.shields.io/github/contributors/TRaSH-/Guides?color=4051B5&style=flat-square){ .off-glb }](https://github.com/TRaSH-/Guides/graphs/contributors){:target="_blank" rel="noopener noreferrer"} -[![GitHub pull requests](https://img.shields.io/github/issues-pr/TRaSH-/Guides?color=4051B5&style=flat-square){ .off-glb }](https://github.com/TRaSH-/Guides/pulls){:target="_blank" rel="noopener noreferrer"} -[![GitHub issues](https://img.shields.io/github/issues/TRaSH-/Guides?color=4051B5&style=flat-square){ .off-glb }](https://github.com/TRaSH-/Guides/issues){:target="_blank" rel="noopener noreferrer"} +[![GitHub last commit](https://img.shields.io/github/last-commit/TRaSH-Guides/Guides?color=4051B5&label=Last%20Update&style=flat-square){ .off-glb }](https://github.com/TRaSH-Guides/Guides/commits/master){:target="_blank" rel="noopener noreferrer"} +[![GitHub contributors](https://img.shields.io/github/contributors/TRaSH-Guides/Guides?color=4051B5&style=flat-square){ .off-glb }](https://github.com/TRaSH-Guides/Guides/graphs/contributors){:target="_blank" rel="noopener noreferrer"} +[![GitHub pull requests](https://img.shields.io/github/issues-pr/TRaSH-Guides/Guides?color=4051B5&style=flat-square){ .off-glb }](https://github.com/TRaSH-Guides/Guides/pulls){:target="_blank" rel="noopener noreferrer"} +[![GitHub issues](https://img.shields.io/github/issues/TRaSH-Guides/Guides?color=4051B5&style=flat-square){ .off-glb }](https://github.com/TRaSH-Guides/Guides/issues){:target="_blank" rel="noopener noreferrer"} *TRaSH Guides, Guides that aren't trash.* @@ -27,7 +27,7 @@ I try to make my guides as easy as possible for everyone to understand, in my op [![Discord chat](https://img.shields.io/discord/492590071455940612?style=for-the-badge&color=4051B5&logo=discord){ .off-glb }](https://trash-guides.info/discord){:target="_blank" rel="noopener noreferrer"} -If you have questions, suggestions, requests or want to contribute, click the chat badge to join the Discord Channel where you can ask your questions directly or use the following [link](https://github.com/TRaSH-/Guides/issues){:target="_blank" rel="noopener noreferrer"} to open an issue on GitHub. +If you have questions, suggestions, requests or want to contribute, click the chat badge to join the Discord Channel where you can ask your questions directly or use the following [link](https://github.com/TRaSH-Guides/Guides/issues){:target="_blank" rel="noopener noreferrer"} to open an issue on GitHub. Feel free to create a PR if you want to. --- diff --git a/mkdocs.yml b/mkdocs.yml index c4e7c55ac..61a3851de 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,8 +3,8 @@ site_description: Guides mainly for Sonarr/Radarr/Bazarr and everything related site_author: TRaSH site_url: https://trash-guides.info/ -repo_url: https://github.com/TRaSH-/Guides -repo_name: TRaSH-/Guides +repo_url: https://github.com/TRaSH-Guides/Guides +repo_name: TRaSH-Guides copyright: Copyright © 2022 TRaSH @@ -16,7 +16,7 @@ extra: - icon: fontawesome/brands/discord link: https://trash-guides.info/discord - icon: fontawesome/brands/square-github - link: https://github.com/TRaSH-/Guides + link: https://github.com/TRaSH-Guides/Guides extra_css: - stylesheets/extra.css From 53dacd5a9b0bda20b451e442d3db548f9bf8f2aa Mon Sep 17 00:00:00 2001 From: TRaSH Date: Mon, 26 Jun 2023 18:35:01 +0200 Subject: [PATCH 2/5] chore(backend): added branch/pull request naming - Added: Branch naming - Added: Pull Request naming - Added: DRAFT Pull Request - When doing a PR that is WIP --- .github/CONTRIBUTING.md | 52 ++++++++++++++++++++++++++++++++++++----- 1 file changed, 46 insertions(+), 6 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 22d3e72b8..561eb1f7d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -12,16 +12,56 @@ These are mostly guidelines, not rules. Use your best judgment, and feel free to - Make sure that after the changes you don't get any [markdownlint](https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md) errors - If the `metadata.json` and `metadata.schema.json` needs changes, announce it first in the Discord `#development` channel and ping`voidpointer` and `nitsua` so the 3rd party apps don't break :bangbang: +## Branch naming + +We're trying to be as consistent as possible for automation of the changelog. + +- **feat/xxx** Commits, that adds a new feature +- **fix/xxx** Commits, that fixes a bug/issue +- **style/xxx** Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc) +- **chore/xxx** Miscellaneous commits (administrative / cleanup / backend) + +Where 'xxx' can stand for Starr/Sonarr/Radarr/Guide etc + +*Examples:* +`feat/Starr-ELEANOR-to-Scene-CF` +`feat/Radarr-CiNEPHiLES-to-Remux-Tier-02` +`feat/maintenance` +`fix/dv-hdr10-cf-should-match-dv-hdr10+` + +[Source](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13#types){:target="_blank" rel="noopener noreferrer"} + +## Pull Request naming + +We're trying to be as consistent as possible for automation of the changelog. + +- **feat(xxx):** Commits, that adds a new feature +- **fix(xxx):** Commits, that fixes a bug/issue +- **style(xxx):** Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc) +- **chore(xxx):** Miscellaneous commits (administrative / cleanup / backend) + +Where 'xxx' can stand for Starr/Sonarr/Radarr/Guide etc + +*Examples:* +`feat(starr): add ELEANOR to Scene CF` +`feat(radarr): add CiNEPHiLES to Remux Tier 02` +`feat(maintenance): various changes to the Starr CFs` +`fix(starr): DV HDR10 CF should match DV HDR10+` + +[Source](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13#types){:target="_blank" rel="noopener noreferrer"} + +**When doing a PR that is in-progress and not yet complete / ready for review not yet done fully please ensure it is a DRAFT Pull Request** + ## Radarr/Sonarr Custom Format (JSON) - Custom Format name needs to match json name :bangbang: - No hashcode can exists multiple times :bangbang: - JSON file names are always written in small letters, spaces are replaced by a dash, no spaces or special characters except a dash :bangbang: -- When adding the hashcode for Radarr use the following naming `CF_name` on the following [link+example](https://md5.gromweb.com/?string=BR-DISK). -- When adding the hashcode for Radarr Anime use the following naming `Radarr Anime CF_name` on the following [link+example](https://md5.gromweb.com/?string=Radarr+Anime+BR-DISK). -- When adding the hashcode for Sonarr use the following naming `Sonarr CF_name` on the following [link+example](https://md5.gromweb.com/?string=Sonarr+BR-DISK). -- When adding the hashcode for Sonarr Anime use the following naming `Sonarr Anime CF_name` on the following [link+example](https://md5.gromweb.com/?string=Sonarr+Anime+BR-DISK). -- Provide a link to your regex example of your Custom Format using the following [Template](https://regex101.com/r/fXmQQm/1). +- When adding the hashcode for Radarr use the following naming `CF_name` on the following [link+example](https://md5.gromweb.com/?string=BR-DISK){:target="_blank" rel="noopener noreferrer"}. +- When adding the hashcode for Radarr Anime use the following naming `Radarr Anime CF_name` on the following [link+example](https://md5.gromweb.com/?string=Radarr+Anime+BR-DISK){:target="_blank" rel="noopener noreferrer"}. +- When adding the hashcode for Sonarr use the following naming `Sonarr CF_name` on the following [link+example](https://md5.gromweb.com/?string=Sonarr+BR-DISK){:target="_blank" rel="noopener noreferrer"}. +- When adding the hashcode for Sonarr Anime use the following naming `Sonarr Anime CF_name` on the following [link+example](https://md5.gromweb.com/?string=Sonarr+Anime+BR-DISK){:target="_blank" rel="noopener noreferrer"}. +- Provide a link to your regex example of your Custom Format using the following [Template](https://regex101.com/r/4DypIW/1){:target="_blank" rel="noopener noreferrer"}. - When adding a RlsGRp to a Custom Format for what ever reason, please add in the PR why it's added/removed/moved. When adding a regex test case @@ -48,4 +88,4 @@ When updating or adding a new CF the test case url needs to be added to the json ## Recommendations -- use [VSCode](https://code.visualstudio.com/) for editing with the following extension [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) +- use [VSCode](https://code.visualstudio.com/){:target="_blank" rel="noopener noreferrer"} for editing with the following extension [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint){:target="_blank" rel="noopener noreferrer"} From 3f5aa76bf578961533bb2457e0d8380163db777f Mon Sep 17 00:00:00 2001 From: TRaSH Date: Mon, 26 Jun 2023 18:44:41 +0200 Subject: [PATCH 3/5] chore(backend): fix MD036 --- .github/CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 561eb1f7d..1ac81e7ac 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -50,7 +50,9 @@ Where 'xxx' can stand for Starr/Sonarr/Radarr/Guide etc [Source](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13#types){:target="_blank" rel="noopener noreferrer"} -**When doing a PR that is in-progress and not yet complete / ready for review not yet done fully please ensure it is a DRAFT Pull Request** +## When doing a PR that is WIP + +When doing a PR that is in-progress and not yet complete / ready for review not yet done fully please ensure it is a **DRAFT Pull Request** ## Radarr/Sonarr Custom Format (JSON) From f6db9215eef88229c75947ff8c098dcbcc3a0f7c Mon Sep 17 00:00:00 2001 From: bakerboy448 <55419169+bakerboy448@users.noreply.github.com> Date: Mon, 26 Jun 2023 12:09:36 -0500 Subject: [PATCH 4/5] fixup! chore(backend): added branch/pull request naming --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 1ac81e7ac..781dca4be 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -64,7 +64,7 @@ When doing a PR that is in-progress and not yet complete / ready for review not - When adding the hashcode for Sonarr use the following naming `Sonarr CF_name` on the following [link+example](https://md5.gromweb.com/?string=Sonarr+BR-DISK){:target="_blank" rel="noopener noreferrer"}. - When adding the hashcode for Sonarr Anime use the following naming `Sonarr Anime CF_name` on the following [link+example](https://md5.gromweb.com/?string=Sonarr+Anime+BR-DISK){:target="_blank" rel="noopener noreferrer"}. - Provide a link to your regex example of your Custom Format using the following [Template](https://regex101.com/r/4DypIW/1){:target="_blank" rel="noopener noreferrer"}. -- When adding a RlsGRp to a Custom Format for what ever reason, please add in the PR why it's added/removed/moved. +- When adding a RlsGrp to a Custom Format for whatever reason, please add in the PR why it's added/removed/moved. When adding a regex test case From 3b978033eec5b5f959763d524c671f5fbff67a26 Mon Sep 17 00:00:00 2001 From: bakerboy448 <55419169+bakerboy448@users.noreply.github.com> Date: Mon, 26 Jun 2023 12:32:04 -0500 Subject: [PATCH 5/5] fixup! chore(backend): added branch/pull request naming --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 781dca4be..c5969d603 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -52,7 +52,7 @@ Where 'xxx' can stand for Starr/Sonarr/Radarr/Guide etc ## When doing a PR that is WIP -When doing a PR that is in-progress and not yet complete / ready for review not yet done fully please ensure it is a **DRAFT Pull Request** +When doing a PR that is in-progress and not yet complete / ready for review or not yet done fully, please ensure it is a **DRAFT Pull Request** ## Radarr/Sonarr Custom Format (JSON)