diff --git a/.github/workflows/lint-test.yaml b/.github/workflows/lint-test.yaml index 9f746fa6..45739610 100644 --- a/.github/workflows/lint-test.yaml +++ b/.github/workflows/lint-test.yaml @@ -6,6 +6,7 @@ on: - '.github/**' - 'charts/**/README.md' - 'CODE_OF_CONDUCT.md' + - 'CONTRIBUTING.md' - 'LICENSE' - 'README.md' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..b2c5c56b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Welcome + +Thanks for considering a contribution to this Nextcloud repository run by the community! Please make sure you review the [Code of Conduct](./CODE_OF_CONDUCT.md) before proceeding, and keep in mind that this repository is run by volunteers. + +# Pull Requests + +Before submitting a feature or fix PR, please make sure the following are done: + +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`. + +Then, please make sure you follow the [pull request template](.github/pull_request_template.md), so we can more quickly review. + +# Issues + +Please make sure you follow one of the [issue templates](.github/ISSUE_TEMPLATE) so we can better help troubleshoot with you.