chrisryn/requestarr
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs(helm): add contributing guidelines for helm chart (#1486)

Browse Source 
Signed-off-by: Ludovic Ortega <ludovic.ortega@adminafk.fr>
This commit is contained in:
Ludovic Ortega
2025-03-17 10:50:08 +01:00
committed by GitHub
parent f884ac9c66
commit 0bd6d57834
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
CONTRIBUTING.md
View File

@@ -58,12 +58,27 @@ All help is welcome and greatly appreciated! If you would like to contribute to
- Be sure to follow both the [code](#contributing-code) and [UI text](#ui-text-style) guidelines. - Be sure to follow both the [code](#contributing-code) and [UI text](#ui-text-style) guidelines.
- Should you need to update your fork, you can do so by rebasing from `upstream`: - Should you need to update your fork, you can do so by rebasing from `upstream`:
```bash ```bash
git fetch upstream git fetch upstream
git rebase upstream/develop git rebase upstream/develop
git push origin BRANCH_NAME -f git push origin BRANCH_NAME -f
``` ```
### Helm Chart
Tools Required:
- [Helm](https://helm.sh/docs/intro/install/)
- [helm-docs](https://github.com/norwoodj/helm-docs)
Steps:
1. Make the necessary changes.
2. Test your changes.
3. Update the `version` in `charts/jellyseerr-chart/Chart.yaml` following [Semantic Versioning (SemVer)](https://semver.org/).
4. Run the `helm-docs` command to regenerate the chart's README.
### Contributing Code ### Contributing Code
- If you are taking on an existing bug or feature ticket, please comment on the [issue](https://github.com/fallenbagel/jellyseerr/issues) to avoid multiple people working on the same thing. - If you are taking on an existing bug or feature ticket, please comment on the [issue](https://github.com/fallenbagel/jellyseerr/issues) to avoid multiple people working on the same thing.