Skip to content

Commit

Permalink
Add brief component overview to contributing guide (open-telemetry#5690)
Browse files Browse the repository at this point in the history
Signed-off-by: Martin Hickey <[email protected]>
  • Loading branch information
hickeyma authored Jul 19, 2022
1 parent a363e70 commit 297249e
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,15 @@ reasonably fast reviews.

### When adding a new component

Consider submitting different PRs:
Components comprise of exporters, extensions, receivers, and processors. The key criteria to implementing a component is to:

* Implement the `component.Component` interface
* Provide a configuration structure which defines the configuration of the component
* Provide the implementation which performs the component operation

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.

When submitting a component to the community, consider breaking it down into separate PRs as follows:

* First PR should include the overall structure of the new component:
* Readme, configuration, and factory implementation usually using the helper
Expand Down

0 comments on commit 297249e

Please sign in to comment.