Skip to content

Commit

Permalink
Clarifying expectations of contributing to the collector (open-teleme…
Browse files Browse the repository at this point in the history
…try#6685)

* Clarifying expectations with regards to adding components into the
collector

* Fixing up the line wrapping in the project

* Fixing wording withing guideline
  • Loading branch information
MovieStoreGuy committed Dec 15, 2021
1 parent 79ad801 commit 8e72991
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ contributors.
- Add a `replace` directive at the root `go.mod` file so your component is
included in the build of 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 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.

## General Recommendations
Below are some recommendations that apply to typical components. These are not
Expand Down

0 comments on commit 8e72991

Please sign in to comment.