Skip to content

Commit d5344ca

Browse files
authored
[chore] Fix some wording in CONTRIBUTING.md (open-telemetry#27771)
Fixes some incorrect wording in the contributing documentation
1 parent 4a1d7c8 commit d5344ca

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ providing the following information:
111111
components, having a sponsor means that your use case has been validated.
112112
* Some information about your component, such as the reasoning behind it, use-cases, telemetry data types supported, and
113113
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.
116116
117117
Components refer to connectors, exporters, extensions, processors, and receivers. The key criteria to implementing a component is to:
118118
@@ -121,7 +121,7 @@ Components refer to connectors, exporters, extensions, processors, and receivers
121121
* Provide the implementation which performs the component operation
122122
* 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)).
123123
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.
125125
[Building a Trace Receiver](https://opentelemetry.io/docs/collector/trace-receiver/) tutorial provides a detailed example of building a component.
126126
127127
*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.
130130
131131
Generally, maintenance of components is the responsibility of contributors who authored them. If the original author or
132132
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.
135135
136136
- Create your component under the proper folder and use Go standard package naming recommendations.
137137
- Use a boiler-plate Makefile that just references the one at top level, ie.: `include ../../Makefile.Common` - this

0 commit comments

Comments
 (0)