diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c5969d603..0f3de6c8f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -24,12 +24,13 @@ We're trying to be as consistent as possible for automation of the changelog. 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"} +- `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) ## Pull Request naming @@ -43,12 +44,13 @@ We're trying to be as consistent as possible for automation of the changelog. 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"} +- `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) ## When doing a PR that is WIP @@ -59,11 +61,11 @@ When doing a PR that is in-progress and not yet complete / ready for review or n - 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){: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 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/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 a regex test case @@ -90,4 +92,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/){: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"} +- use [VSCode](https://code.visualstudio.com/) for editing with the following extension [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)