Skip to content

Make the contributing guidelines for fluent-operator chart more visible #603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marcofranssen wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Make the contributing guidelines for fluent-operator chart more visible #603

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b605b97
Make the contributing guidelines for fluent-operator chart more visible
marcofranssen May 9, 2025
097ed70
Apply suggestion from @marcofranssen
marcofranssen Jan 23, 2026
5ebc224
Apply suggestion from @marcofranssen
marcofranssen Jan 23, 2026
e6b982f
Apply suggestion from @marcofranssen
marcofranssen Jan 23, 2026
c98cebb
Apply suggestion from @marcofranssen
marcofranssen Jan 23, 2026
cf82829
Apply suggestions from code review
marcofranssen Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Comment thread
marcofranssen marked this conversation as resolved.
Outdated

### 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].
Comment thread
marcofranssen marked this conversation as resolved.
Outdated

### 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
Comment thread
marcofranssen marked this conversation as resolved.
Outdated

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.

@stevehipwell stevehipwell Jan 23, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is no longer relevant, chart releases should be managed by the maintainers. Chart contributions should be accumulated without modifying the chart version, unless explicitly requested by a maintainer.

Comment thread
marcofranssen marked this conversation as resolved.
Outdated

### 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:

@stevehipwell stevehipwell Jan 23, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New charts should initially be added with 0.0.x or 0.x.yversions, with the eventual aim to hitv1.0.0. It may be useful to release 1.0.0-beta.xor1.0.0-rc.x` versions.

Existing charts may want to use x.0.0-beta.y or x.y.0-rc.z versions.


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
Comment thread
marcofranssen marked this conversation as resolved.
Outdated

### 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).
Comment on lines +59 to +72

@stevehipwell stevehipwell Feb 27, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anything in here that's missing from the sections above could be added there.


[fluent-operator-chart]: https://github.com/fluent/fluent-operator/tree/master/charts/fluent-operator "Sources for the fluent-operator Chart"