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
+39-5
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,30 @@
1
1
# Contributing Guide
2
2
3
+
🎉 Welcome to the OpenTelemetry Helm Charts Repository! 🎉
4
+
5
+
## Introduction
6
+
7
+
This repository hosts Helm charts for deploying OpenTelemetry components in Kubernetes. Your contributions help improve observability for everyone! Whether you’re fixing a configuration, adding a new feature, or improving documentation, we appreciate your effort!
8
+
3
9
We'd love your help!
4
10
5
-
## How to Contribute
11
+
## Pre-requisites
12
+
13
+
To work with this repository, ensure you have:
14
+
15
+
- Helm 3.8+
16
+
17
+
- chart-testing (ct) 3.7+
18
+
19
+
- Kubernetes CLI (kubectl)
20
+
21
+
- make (for automation)
22
+
23
+
### Platform Notes
24
+
25
+
Docker or Kubernetes cluster access (for testing chart installations)
* Must follow [Charts best practices](https://helm.sh/docs/topics/chart_best_practices/)
21
51
* Must pass CI jobs for linting and installing changed charts with the
@@ -27,12 +57,12 @@ section of general project contributing guide.
27
57
Once changes have been merged, the release job will automatically run to package
28
58
and release changed charts.
29
59
30
-
###Immutability
60
+
## Immutability
31
61
32
62
Chart releases must be immutable. Any change to a chart warrants a chart version
33
63
bump even if it is only changed to the documentation.
34
64
35
-
###Versioning
65
+
## Versioning
36
66
37
67
The chart `version` should follow [semver](https://semver.org/).
38
68
@@ -43,7 +73,7 @@ Any breaking (backwards incompatible) changes to a chart should:
43
73
2. In the README, under a section called "Upgrading", describe the manual steps
44
74
necessary to upgrade to the new (specified) MAJOR version
45
75
46
-
###Examples
76
+
## Examples
47
77
48
78
All charts maintain examples for the current version. After updating the version, examples must be updated with the `make generate-examples` target.
49
79
@@ -53,6 +83,10 @@ If you need update a single chart's examples you can use the `CHARTS` variable.
53
83
54
84
New examples should be added as independent folders in the respective chart's `examples` folder. Examples should always contain a `values.yaml` and a `rendered` folder.
55
85
86
+
## Further Help
87
+
88
+
- Join [#helm-charts](https://cloud-native.slack.com/archives/C03HVLM8LAH) on OpenTelemetry Slack.
0 commit comments