Skip to content

Commit 2874f8c

Browse files
authored
Update contributing guide (open-telemetry#542)
1 parent bf4386e commit 2874f8c

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

CONTRIBUTING.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -36,22 +36,22 @@ bump even if it is only changed to the documentation.
3636

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

39-
Charts should start at `0.1.0` or `1.0.0`. Any breaking (backwards incompatible)
40-
changes to a chart should:
39+
All changes to a chart require a version bump, following semvar.
4140

42-
1. Bump the MAJOR version
41+
Any breaking (backwards incompatible) changes to a chart should:
42+
1. Bump the MINOR version
4343
2. In the README, under a section called "Upgrading", describe the manual steps
4444
necessary to upgrade to the new (specified) MAJOR version
4545

46-
### Adding new examples
46+
### Examples
4747

48-
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.
48+
All charts maintain examples for the current version. After updating the version, examples must be updated with the `make generate-examples` target.
49+
50+
The default `generate-examples` command will update all charts. In order generate a chart's examples you must have the chart's dependencies added to your helm repo.
4951

50-
To generate the rendered files run:
52+
If you need update a single chart's examples you can use the `CHARTS` variable. For example, if you want to update only the collector chart's examples you can run `make generate-examples CHARTS=opentelemetry-collector`
5153

52-
```console
53-
make generate-examples
54-
```
54+
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.
5555

5656
### Chart-specific Contributing Guides
5757

0 commit comments

Comments
 (0)