open-telemetry
/
opentelemetry-java
mirror of https://github.com/open-telemetry/opentelemetry-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Define project scope (#4753) 

* Define project scope

* PR feedback

* Refine kotlin extension phrasing
This commit is contained in:
jack-berg 2022-09-27 09:16:54 -05:00 committed by GitHub
parent a1cf20d1c5
commit 206ca2731b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md
View File

@ -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