Skip to content

Commit

Permalink
[pkg] Add README documenting the purpose of the folder (open-telemetr…
Browse files Browse the repository at this point in the history
  • Loading branch information
mx-psi committed Jul 25, 2022
1 parent a088337 commit c1de5ae
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions pkg/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# `pkg` folder

The Go modules in this folder can help in building new components (receivers, processors, exporters, extensions...) and are meant for **external** consumption.
Carefully review the public API to ensure that we only expose what is deemed necessary, so that we can easily change the code without affecting external users.

Breaking changes can happen on any module on this folder under the [opentelemetry-collector contribution guidelines](https://github.com/open-telemetry/opentelemetry-collector/blob/main/CONTRIBUTING.md#breaking-changes).

If you are introducing a new module that will only be used by components in the opentelemetry-collector-contrib repository, consider placing it on the `internal` folder instead.
This will reduce our public API footprint and maintenance burden.

0 comments on commit c1de5ae

Please sign in to comment.