ChoChoX/suwayomi-material-you-webui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix contributing readme (#405)

Browse Source
This commit is contained in:
schroda
2023-08-14 21:43:18 +02:00
committed by GitHub
parent 48fe8d23e9
commit ebf6c99dee
2 changed files with 13 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CHANGELOG-TEMPLATE.md Normal file
View File

@@ -0,0 +1,8 @@
# vX.Y.Z (rXXX)
## TL;DR
- N/A
## Full Changelog
- N/A (latest commit to oldest commit)

10
CONTRIBUTING.md
View File

@@ -9,18 +9,18 @@ See [BUILDING.md](./BUILDING.md) for more information
## Release process
1. Update the changelog
1. Copy the content of the template changelog to the top of the actual changelog
2. Create the changelog since the latest release (printed in console) with `npm run createChangelog -- --sha <latest commit hash of previous release>`
1. Copy the content of the [template changelog](CHANGELOG-TEMPLATE.md) to the top of the actual changelog
2. Create the changelog for the new release with `npm run createChangelog -- --sha <latest commit hash of previous release>` (printed in console)
3. Copy the changelog to the corresponding position in the template
4. Create a TL;DR
2. Update the [version to server version mapping file](versionToServerVersionMapping.json)
1. See [When to update](#when-to-update)
1. See [wWen to update](#when-to-update)
## WebUI to [server](https://github.com/Suwayomi/Tachidesk-Server) mapping
## WebUI to [Server](https://github.com/Suwayomi/Tachidesk-Server) mapping
### Explanation
For the server to be able to automatically download the latest compatible WebUI version, the [version to server version mapping file](versionToServerVersionMapping.json) has to be provided.<br/>
The order of the version mapping is important and has to be sorted by oldest WebUI version to latest version.<br/>
The order of the version mapping is important and has to be sorted by latest WebUI version to the oldest version.<br/>
The latest version will always be `PREVIEW`.
### When to update