Skip to content

Commit 28c3708

Browse files
RichardChukwuJaredTan95puckpuckdmitryax
authored
Improve Contributor Guide (#1511)
* Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: Jared Tan <jian.tan@daocloud.io> * Update CONTRIBUTING.md Co-authored-by: Jared Tan <jian.tan@daocloud.io> * Update CONTRIBUTING.md * Update CONTRIBUTING.md --------- Co-authored-by: Jared Tan <jian.tan@daocloud.io> Co-authored-by: Pierre Tessier <pierre@pierretessier.com> Co-authored-by: Dmitrii Anoshin <anoshindx@gmail.com>
1 parent be4c265 commit 28c3708

File tree

1 file changed

+39
-5
lines changed

1 file changed

+39
-5
lines changed

CONTRIBUTING.md

+39-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,30 @@
11
# Contributing Guide
22

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+
39
We'd love your help!
410

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)
26+
27+
## Workflow
628

729
1. Fork this repository
830
1. Develop, and test your changes
@@ -15,7 +37,15 @@ Please also see [GitHub
1537
workflow](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md#github-workflow)
1638
section of general project contributing guide.
1739

18-
### Technical Requirements
40+
Local Run/Build
41+
42+
TBD
43+
44+
Testing
45+
46+
TBD
47+
48+
## Technical Requirements
1949

2050
* Must follow [Charts best practices](https://helm.sh/docs/topics/chart_best_practices/)
2151
* Must pass CI jobs for linting and installing changed charts with the
@@ -27,12 +57,12 @@ section of general project contributing guide.
2757
Once changes have been merged, the release job will automatically run to package
2858
and release changed charts.
2959

30-
### Immutability
60+
## Immutability
3161

3262
Chart releases must be immutable. Any change to a chart warrants a chart version
3363
bump even if it is only changed to the documentation.
3464

35-
### Versioning
65+
## Versioning
3666

3767
The chart `version` should follow [semver](https://semver.org/).
3868

@@ -43,7 +73,7 @@ Any breaking (backwards incompatible) changes to a chart should:
4373
2. In the README, under a section called "Upgrading", describe the manual steps
4474
necessary to upgrade to the new (specified) MAJOR version
4575

46-
### Examples
76+
## Examples
4777

4878
All charts maintain examples for the current version. After updating the version, examples must be updated with the `make generate-examples` target.
4979

@@ -53,6 +83,10 @@ If you need update a single chart's examples you can use the `CHARTS` variable.
5383

5484
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.
5585

86+
## Further Help
87+
88+
- Join [#helm-charts](https://cloud-native.slack.com/archives/C03HVLM8LAH) on OpenTelemetry Slack.
89+
5690
### Chart-specific Contributing Guides
5791

5892
- [opentelemetry-collector](./charts/opentelemetry-collector/CONTRIBUTING.md)

0 commit comments

Comments
 (0)