Skip to content
Open
Changes from 4 commits
Commits
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
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,34 @@
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

Check failure on line 71 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / Setup

MD051

Link anchor '#versioning' does not exist in document headings
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.

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

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"
Loading