Skip to content

Commit

Permalink
Add metadata.yaml as a requirement
Browse files Browse the repository at this point in the history
This PR adds the metadata.yaml as a requirement in the contributing guidelines.

Fixes: open-telemetry/opentelemetry-collector-contrib#20908.
  • Loading branch information
mackjmr committed Jun 13, 2023
1 parent 880e47c commit 17e26f6
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ Components refer to connectors, exporters, extensions, processors, and receivers
* Implement the `component.Component` interface
* Provide a configuration structure which defines the configuration of the component
* Provide the implementation which performs the component operation
* Have a `metadata.yaml` file and it's generated code (using [mdatadgen](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/cmd/mdatagen/README.md)).

For more details on components, see the [Adding New Components](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#adding-new-components) document and the tutorial [Building a Trace Receiver](https://opentelemetry.io/docs/collector/trace-receiver/) which provides a detailed example of building a component.

Expand All @@ -56,6 +57,7 @@ When submitting a component to the community, consider breaking it down into sep
* **First PR** should include the overall structure of the new component:
* Readme, configuration, and factory implementation usually using the helper
factory structs.
* `metadata.yaml` and it's generated code (using [mdatadgen](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/cmd/mdatagen/README.md)).
* This PR is usually trivial to review, so the size limit does not apply to
it.
* The component should use [`In Development` Stability](https://github.com/open-telemetry/opentelemetry-collector#development) in its README.
Expand Down

0 comments on commit 17e26f6

Please sign in to comment.