diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cce4d52b304d..49bfc197507c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -164,10 +164,15 @@ and its contributors. available configuration settings so users can copy and modify them as needed. - Run `make crosslink` to update intra-repository dependencies. It will add a `replace` directive to `go.mod` file of every intra-repository dependant. This is necessary for your component to be included in the contrib executable. - Add your component to `versions.yaml`. -- All components included in the distribution must be included in [`cmd/otelcontribcol/builder-config.yaml`](./cmd/otelcontribcol/builder-config.yaml) - and in the respective testing harnesses. To align with the test goal of the project, components must be testable within the framework defined within - the folder. If a component can not be properly tested within the existing framework, it must increase the non testable - components number with a comment within the PR explaining as to why it can not be tested. +- All components included in the distribution must be included in + [`cmd/otelcontribcol/builder-config.yaml`](./cmd/otelcontribcol/builder-config.yaml) + and in the respective testing harnesses. To align with the test goal of the + project, components must be testable within the framework defined within the + folder. If a component can not be properly tested within the existing + framework, it must increase the non testable components number with a comment + within the PR explaining as to why it can not be tested. **(Note: this does + not automatically include any components in official release binaries. See + [Releasing new components](#releasing-new-components).)** - Create a `metadata.yaml` file with at minimum the required fields defined in [metadata-schema.yaml](https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/mdatagen/metadata-schema.yaml). Here is a minimal representation: