From b6a56e79c11e825ab7088fbaa1178cd50dee4cfb Mon Sep 17 00:00:00 2001 From: Jack Berg Date: Mon, 12 Sep 2022 17:12:56 -0500 Subject: [PATCH 1/3] Define project scope --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da4bacd43cb..597355462fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,6 +60,34 @@ 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 the project 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. +* The [Kotlin Extension](./extensions/kotlin) contains code which assists with context propagation + for an important part of the Java ecosystem. +* 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 use these semantic conventions belongs 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 From 641d53d5e9325b52789be63359c66cebf525c336 Mon Sep 17 00:00:00 2001 From: Jack Berg Date: Tue, 13 Sep 2022 11:17:39 -0500 Subject: [PATCH 2/3] PR feedback --- CONTRIBUTING.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 597355462fd..c80f001f466 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,10 +62,10 @@ restricted members (administrators). ## Project Scope -`opentelemetry-java` is one of several repositories which comprise the OpenTelemetry java ecosystem, +`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 the project scope to components which -implement concepts defined in +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: @@ -76,10 +76,10 @@ with a few exceptions / comments: * The [Kotlin Extension](./extensions/kotlin) contains code which assists with context propagation for an important part of the Java ecosystem. * 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 use these semantic conventions belongs elsewhere. + 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: +Other repositories in the OpenTelemetry Java ecosystem include: * [opentelemetry-java-instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation) contains instrumentation. From 9f22831e29e507ceaee47a3e7eb8a6948117f30e Mon Sep 17 00:00:00 2001 From: Jack Berg Date: Wed, 21 Sep 2022 09:52:12 -0500 Subject: [PATCH 3/3] Refine kotlin extension phrasing --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c80f001f466..936243259e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,8 +73,9 @@ with a few exceptions / comments: 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. -* The [Kotlin Extension](./extensions/kotlin) contains code which assists with context propagation - for an important part of the Java ecosystem. +* 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.