Skip to content

Commit 6bf41e4

Browse files
mackjmrsongy23
andauthored
Add metadata.yaml as a requirement (open-telemetry#23340)
Fixes: open-telemetry#20908. --------- Co-authored-by: Yang Song <[email protected]>
1 parent 563fd6f commit 6bf41e4

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

CONTRIBUTING.md

+2
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@ Components refer to connectors, exporters, extensions, processors, and receivers
110110
* Implement the [component.Component](https://pkg.go.dev/go.opentelemetry.io/collector/component#Component) interface
111111
* Provide a configuration structure which defines the configuration of the component
112112
* Provide the implementation which performs the component operation
113+
* Have a `metadata.yaml` file and its generated code (using [mdatadgen](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/cmd/mdatagen/README.md)).
113114
114115
Familiarize yourself with the interface of the component that you want to write, and use existing implementations as reference.
115116
[Building a Trace Receiver](https://opentelemetry.io/docs/collector/trace-receiver/) tutorial provides a detailed example of building a component.
@@ -145,6 +146,7 @@ and the rest of contributors.
145146
- Add the sponsor for your component and yourself to a new line for your component in the
146147
[`.github/CODEOWNERS`](./.github/CODEOWNERS) file.
147148
- Run `make generate-gh-issue-templates` to add your component to the dropdown list in the issue templates.
149+
- Create a `metadata.yaml` file with at minimum the required fields defined in [metadata-schema.yaml](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/cmd/mdatagen/metadata-schema.yaml) and use the [metadata generator](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/cmd/mdatagen/README.md#using-the-metadata-generator) to generate the associated code/documentation.
148150
149151
When submitting a component to the community, consider breaking it down into separate PRs as follows:
150152

0 commit comments

Comments
 (0)