From b605b97b64c88e2c72ea840dca5c6047b380ce78 Mon Sep 17 00:00:00 2001 From: Marco Franssen Date: Fri, 9 May 2025 13:13:36 +0200 Subject: [PATCH 1/6] Make the contributing guidelines for fluent-operator chart more visible Signed-off-by: Marco Franssen --- CONTRIBUTING.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e2b65626..30cfcd87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,3 +48,47 @@ See `git help commit`: license and agrees to a Developer Certificate of Origin (see http://developercertificate.org/ for more information). ``` + +## How to Contribute + +1. Fork this repository, develop, and test your changes +2. Remember to sign off your commits as described above +3. Submit a pull request + +> [!Note] +> In order to make testing and merging of PRs easier, please submit changes to multiple charts in separate PRs. + +### Fluent Operator Chart + +> [!Important] +> The fluent-operator Chart is maintained in [this repository][fluent-operator-chart]. Please **do NOT submit PRs** for the fluent-operator Chart in this repository! Do all contributions in the [fluent-operator repository][fluent-operator-chart]. + +### Technical Requirements + +- Must pass [DCO check](#sign-off-your-work) +- Must follow [Charts best practices](https://helm.sh/docs/topics/chart_best_practices/) +- Must pass CI jobs for linting and installing changed charts with the [chart-testing](https://github.com/helm/chart-testing) tool +- Any change to a chart requires a version bump following [semver](https://semver.org/) principles. See [Immutability(#immutability) and [Versioning](#versioning) below + +Once changes have been merged, the release job will automatically run to package and release changed charts. + +### Immutability + +Chart releases must be immutable. Any change to a chart warrants a chart version bump even if it is only changed to the documentation. + +### Versioning + +The chart `version` should follow [semver](https://semver.org/). + +Charts should start at `1.0.0`. Any breaking (backwards incompatible) changes to a chart should: + +1. Bump the MAJOR version +2. In the README, under a section called "Upgrading", describe the manual steps necessary to upgrade to the new (specified) MAJOR version + +### Community Requirements + +This project is released with a [Contributor Covenant](https://www.contributor-covenant.org). +By participating in this project you agree to abide by its terms. +See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md). + +[fluent-operator-chart]: https://github.com/fluent/fluent-operator/tree/master/charts/fluent-operator "Sources for the fluent-operator Chart" From 097ed70d2bbe4fdf132971ac5d95938fdccf701a Mon Sep 17 00:00:00 2001 From: Marco Franssen Date: Fri, 23 Jan 2026 16:28:00 +0100 Subject: [PATCH 2/6] Apply suggestion from @marcofranssen Signed-off-by: Marco Franssen --- CONTRIBUTING.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 30cfcd87..3ea7b4a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,9 +72,6 @@ See `git help commit`: Once changes have been merged, the release job will automatically run to package and release changed charts. -### Immutability - -Chart releases must be immutable. Any change to a chart warrants a chart version bump even if it is only changed to the documentation. ### Versioning From 5ebc22493d4f25dba9dd3a4bb1df9fbe50492ca4 Mon Sep 17 00:00:00 2001 From: Marco Franssen Date: Fri, 23 Jan 2026 16:28:27 +0100 Subject: [PATCH 3/6] Apply suggestion from @marcofranssen Signed-off-by: Marco Franssen --- CONTRIBUTING.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3ea7b4a4..8fd80c41 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,14 +73,6 @@ See `git help commit`: Once changes have been merged, the release job will automatically run to package and release changed charts. -### Versioning - -The chart `version` should follow [semver](https://semver.org/). - -Charts should start at `1.0.0`. Any breaking (backwards incompatible) changes to a chart should: - -1. Bump the MAJOR version -2. In the README, under a section called "Upgrading", describe the manual steps necessary to upgrade to the new (specified) MAJOR version ### Community Requirements From e6b982fa91cce60fe521af312a427a9564712eb9 Mon Sep 17 00:00:00 2001 From: Marco Franssen Date: Fri, 23 Jan 2026 16:29:01 +0100 Subject: [PATCH 4/6] Apply suggestion from @marcofranssen Signed-off-by: Marco Franssen --- CONTRIBUTING.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8fd80c41..79f08f3d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,8 +72,6 @@ See `git help commit`: Once changes have been merged, the release job will automatically run to package and release changed charts. - - ### Community Requirements This project is released with a [Contributor Covenant](https://www.contributor-covenant.org). From c98cebb77d4290893320cac0f56abea056d1d7aa Mon Sep 17 00:00:00 2001 From: Marco Franssen Date: Fri, 23 Jan 2026 16:30:01 +0100 Subject: [PATCH 5/6] Apply suggestion from @marcofranssen Signed-off-by: Marco Franssen --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 79f08f3d..b920d7e8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,7 +68,7 @@ See `git help commit`: - Must pass [DCO check](#sign-off-your-work) - Must follow [Charts best practices](https://helm.sh/docs/topics/chart_best_practices/) - Must pass CI jobs for linting and installing changed charts with the [chart-testing](https://github.com/helm/chart-testing) tool -- Any change to a chart requires a version bump following [semver](https://semver.org/) principles. See [Immutability(#immutability) and [Versioning](#versioning) below +- Any change to a chart requires a version bump following [semver](https://semver.org/) principles. Once changes have been merged, the release job will automatically run to package and release changed charts. From cf82829151aabdc760d7a5106dfd7175d9808dd4 Mon Sep 17 00:00:00 2001 From: Marco Franssen Date: Fri, 27 Feb 2026 17:20:07 +0100 Subject: [PATCH 6/6] Apply suggestions from code review Co-authored-by: Steve Hipwell Signed-off-by: Marco Franssen --- CONTRIBUTING.md | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b920d7e8..dbcf48c3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,19 +49,12 @@ See `git help commit`: http://developercertificate.org/ for more information). ``` -## How to Contribute - -1. Fork this repository, develop, and test your changes -2. Remember to sign off your commits as described above -3. Submit a pull request - -> [!Note] -> In order to make testing and merging of PRs easier, please submit changes to multiple charts in separate PRs. +## Chart Instructions ### Fluent Operator Chart > [!Important] -> The fluent-operator Chart is maintained in [this repository][fluent-operator-chart]. Please **do NOT submit PRs** for the fluent-operator Chart in this repository! Do all contributions in the [fluent-operator repository][fluent-operator-chart]. +> The _fluent-operator_ chart is maintained in the [fluent/fluent-operator][fluent-operator-chart] repository. Please **DO NOT** submit PRs for the _fluent-operator_ chart directly in this repository! ### Technical Requirements