diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b2c5c56b..11c64ff2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,13 +4,21 @@ Thanks for considering a contribution to this Nextcloud repository run by the co # Pull Requests -Before submitting a feature or fix PR, please make sure the following are done: +Before submitting a feature or fix PR, please make sure your changes are targetted to one feature or fix, and all your commits are signed off. (Learn more the DCO [here](https://probot.github.io/apps/dco)) -1. Make sure all your commits are signed off. (Learn more the DCO [here](https://probot.github.io/apps/dco)) -2. Any new or changed values are updated in the [values.yaml](./charts/nextcloud/values.yaml) and the [README.md](./charts/nextcloud/README.md) -3. Bump the `version` in the [Chart.yaml](./charts/nextcloud/Chart.yaml) according to [Semantic Versioning](https://semver.org) which uses the format `major.minor.patch`. +If you're making a change to the chart templates or `values.yaml`, please also do the following: + +1. Ensure the chart is linted using [`helm lint`](https://helm.sh/docs/helm/helm_lint/) +2. Test rendering the helm templates from the chart root dir (`charts/nextcloud`) using `helm template .` + - If you're making a change to a non-default value, please also test that value change locally. You can pass in a custom values file to `helm template` with `--values mycustomvalues.yaml` +3. Test installing the chart. A great tool for this is [`ct`](https://github.com/helm/chart-testing/tree/main) using [`ct install`](https://github.com/helm/chart-testing/blob/main/doc/ct_install.md) on a test cluster like [kind](https://kind.sigs.k8s.io/) +4. Make sure new or changed values are updated in the [values.yaml](./charts/nextcloud/values.yaml) and the [README.md](./charts/nextcloud/README.md) +5. Bump the `version` in the [Chart.yaml](./charts/nextcloud/Chart.yaml) according to [Semantic Versioning](https://semver.org) which uses the format `major.minor.patch`. + +Then, please make sure you follow the [pull request template](.github/pull_request_template.md), so we can more quickly review. In order to move your PR forward faster (for instance, bumping the helm chart version for you), please also check the "Allow edits and access to secrets by maintainers" box next to the "Create pull request" button: + +![screenshot of the allow edits by maintainers check box to the left of the Create pull request button on GitHub](https://github.com/nextcloud/helm/assets/2389292/3a8044a9-583d-496a-b3d2-4dd699c56ed4) -Then, please make sure you follow the [pull request template](.github/pull_request_template.md), so we can more quickly review. # Issues diff --git a/README.md b/README.md index 92d464e9..1927ef4b 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ helm repo update For more information, please checkout the chart level [README.md](./charts/nextcloud/README.md). ### Support and Contribution -This helm chart is community maintained, and not supported by Nextcloud GmbH. Please also review the official [NextCloud Code of Conduct](https://nextcloud.com/contribute/code-of-conduct/) before contributing. +This helm chart is community maintained, and not supported by Nextcloud GmbH. Please also review the official [NextCloud Code of Conduct](https://nextcloud.com/contribute/code-of-conduct/) and this repo's [contributing doc](./CONTRIBUTING.md) before contributing. #### Questions and Discussions [GitHub Discussion](https://github.com/nextcloud/helm/discussions)