You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+44Lines changed: 44 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,3 +48,47 @@ See `git help commit`:
48
48
license and agrees to a Developer Certificate of Origin (see
49
49
http://developercertificate.org/ for more information).
50
50
```
51
+
52
+
## How to Contribute
53
+
54
+
1. Fork this repository, develop, and test your changes
55
+
2. Remember to sign off your commits as described above
56
+
3. Submit a pull request
57
+
58
+
> [!Note]
59
+
> In order to make testing and merging of PRs easier, please submit changes to multiple charts in separate PRs.
60
+
61
+
### Fluent Operator Chart
62
+
63
+
> [!Important]
64
+
> 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].
65
+
66
+
### Technical Requirements
67
+
68
+
- Must pass [DCO check](#sign-off-your-work)
69
+
- Must follow [Charts best practices](https://helm.sh/docs/topics/chart_best_practices/)
70
+
- Must pass CI jobs for linting and installing changed charts with the [chart-testing](https://github.com/helm/chart-testing) tool
71
+
- Any change to a chart requires a version bump following [semver](https://semver.org/) principles. See [Immutability(#immutability) and [Versioning](#versioning) below
72
+
73
+
Once changes have been merged, the release job will automatically run to package and release changed charts.
74
+
75
+
### Immutability
76
+
77
+
Chart releases must be immutable. Any change to a chart warrants a chart version bump even if it is only changed to the documentation.
78
+
79
+
### Versioning
80
+
81
+
The chart `version` should follow [semver](https://semver.org/).
82
+
83
+
Charts should start at `1.0.0`. Any breaking (backwards incompatible) changes to a chart should:
84
+
85
+
1. Bump the MAJOR version
86
+
2. In the README, under a section called "Upgrading", describe the manual steps necessary to upgrade to the new (specified) MAJOR version
87
+
88
+
### Community Requirements
89
+
90
+
This project is released with a [Contributor Covenant](https://www.contributor-covenant.org).
91
+
By participating in this project you agree to abide by its terms.
92
+
See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
93
+
94
+
[fluent-operator-chart]: https://github.com/fluent/fluent-operator/tree/master/charts/fluent-operator"Sources for the fluent-operator Chart"
0 commit comments