[chore] Added missing details to CONTRIBUTING.md (#18213)

Explain how to update intra-repository dependencies when adding a new component.
open-telemetry · Feb 1, 2023 · 79d9b3c · 79d9b3c
1 parent 5957f86
commit 79d9b3c
Showing 1 changed file with 1 addition and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -106,8 +106,7 @@ and the rest of contributors.
 - Add a README.md on the root of your component describing its configuration and usage, likely referencing some of the
  yaml files used in the component tests. We also suggest that the yaml files used in tests have comments for all
  available configuration settings so users can copy and modify them as needed.
-- Add a `replace` directive at the root `go.mod` file so your component is included in the build of the contrib
- executable.
+- 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 must be included in [`internal/components/`](./internal/components) and in the respective testing
  harnesses. To align with the test goal of the project, components must be testable within the framework defined within