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
pull/1403/head
TRaSH 1 year ago
parent 824f59b876
commit 53dacd5a9b

@ -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"}

Loading…
Cancel
Save