Skip to content

Commit

Permalink
Define project scope (#4753)
Browse files Browse the repository at this point in the history
* Define project scope

* PR feedback

* Refine kotlin extension phrasing
  • Loading branch information
jack-berg authored Sep 27, 2022
1 parent a1cf20d commit 206ca27
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,35 @@ After you submit a PR, it will be reviewed by the project maintainers and approv
maintainers need to review a particular PR, but merging to the base branch is authorized to
restricted members (administrators).

## Project Scope

`opentelemetry-java` is one of several repositories which comprise the OpenTelemetry Java ecosystem,
and contains the core components upon which instrumentation and extensions are built. In order to
prevent sprawl and maintain a high level of quality, we limit this repository's scope to components
which implement concepts defined in
the [opentelemetry-specification](https://github.com/open-telemetry/opentelemetry-specification),
with a few exceptions / comments:

* The [API incubator](./extensions/incubator) and [SDK incubator](./extensions/incubator)
contain prototypes which have been discussed in the specification
or [oteps](https://github.com/open-telemetry/oteps) and have a reasonable chance of becoming part
of the specification, subject to maintainers' discretion.
* Components like the [Kotlin Extension](./extensions/kotlin) are included which are required for
the API / SDK to function in key areas of the Java ecosystem. Inclusion is subject to maintainers'
discretion.
* The [semconv](./semconv) module contains generated classes representing
the [semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/tree/main/semantic_conventions).
* As a general rule, components which implement semantic conventions belong elsewhere.

Other repositories in the OpenTelemetry Java ecosystem include:

* [opentelemetry-java-instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation)
contains instrumentation.
* [opentelemetry-java-contrib](https://github.com/open-telemetry/opentelemetry-java-contrib)
contains extensions, prototypes, and instrumentation, including vendor specific components.
* [opentelemetry-java-docs](https://github.com/open-telemetry/opentelemetry-java-docs) contains
working code snippets demonstrating various concepts.

## Style guideline

We follow the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html). Our
Expand Down

0 comments on commit 206ca27

Please sign in to comment.