You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -111,8 +111,8 @@ providing the following information:
111
111
components, having a sponsor means that your use case has been validated.
112
112
* Some information about your component, such as the reasoning behind it, use-cases, telemetry data types supported, and
113
113
anything else you think is relevant for us to make a decision about accepting the component.
114
-
* The configuration options your component will accept. This will help us understand what it does and have an idea of
115
-
how the implementation might look like.
114
+
* The configuration options your component will accept. This will give us a better understanding of what it does, and
115
+
how it may be implemented.
116
116
117
117
Components refer to connectors, exporters, extensions, processors, and receivers. The key criteria to implementing a component is to:
118
118
@@ -121,7 +121,7 @@ Components refer to connectors, exporters, extensions, processors, and receivers
121
121
* Provide the implementation which performs the component operation
122
122
* Have a `metadata.yaml` file and its generated code (using [mdatadgen](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/cmd/mdatagen/README.md)).
123
123
124
-
Familiarize yourself with the interface of the component that you want to write, and use existing implementations as reference.
124
+
Familiarize yourself with the interface of the component that you want to write, and use existing implementations as a reference.
125
125
[Building a Trace Receiver](https://opentelemetry.io/docs/collector/trace-receiver/) tutorial provides a detailed example of building a component.
126
126
127
127
*NOTICE:* The Collector is in Beta stage and as such the interfaces may undergo breaking changes. Component creators
@@ -130,8 +130,8 @@ excluded from the default builds.
130
130
131
131
Generally, maintenance of components is the responsibility of contributors who authored them. If the original author or
132
132
some other contributor does not maintain the component it may be excluded from the default build. The component **will**
133
-
be excluded if it causes build problems, has failing tests or otherwise causes problems to the rest of the repository
134
-
and the rest of contributors.
133
+
be excluded if it causes build problems, has failing tests, or otherwise causes problems to the rest of the repository
134
+
and its contributors.
135
135
136
136
- Create your component under the proper folder and use Go standard package naming recommendations.
137
137
- Use a boiler-plate Makefile that just references the one at top level, ie.: `include ../../Makefile.Common` - this
0 commit comments