From 3032304c3bbc124abdde198108868d98bd68b309 Mon Sep 17 00:00:00 2001 From: Greg Pinnington <48593081+stickeegreg@users.noreply.github.com> Date: Tue, 5 Sep 2023 04:38:44 +0100 Subject: [PATCH] Add 'Contributing' message (#1108) Co-authored-by: RoBorg --- proto/otel/README.md | 7 ++++++- src/API/README.md | 7 ++++++- src/Context/README.md | 5 +++++ src/Contrib/Grpc/README.md | 5 +++++ src/Contrib/Otlp/README.md | 5 +++++ src/Contrib/Zipkin/README.md | 5 +++++ src/Extension/Propagator/B3/README.md | 7 ++++++- src/SDK/README.md | 5 +++++ src/SemConv/README.md | 5 +++++ 9 files changed, 48 insertions(+), 3 deletions(-) diff --git a/proto/otel/README.md b/proto/otel/README.md index 7d9c78877..f1ea7a63a 100644 --- a/proto/otel/README.md +++ b/proto/otel/README.md @@ -10,7 +10,7 @@ OTLP exporting requires a [protobuf runtime library](https://github.com/protocolbuffers/protobuf/tree/main/php). -There exist two protobuf runtime libraries that offer the same set of APIs, allowing developers to choose the one that +There exist two protobuf runtime libraries that offer the same set of APIs, allowing developers to choose the one that best suits their needs. This package requires `google/protobuf`, which is the native implementation. It is easy to install and a good way to get @@ -24,3 +24,8 @@ pecl install protobuf ``` The extension can be installed alongside the native library, and it will be used instead if available. + +## Contributing + +This repository is a read-only git subtree split. +To contribute, please see the main [OpenTelemetry PHP monorepo](https://github.com/open-telemetry/opentelemetry-php). diff --git a/src/API/README.md b/src/API/README.md index 16eca96b3..c2cbd1bf1 100644 --- a/src/API/README.md +++ b/src/API/README.md @@ -6,4 +6,9 @@ # OpenTelemetry API -Documentation: https://opentelemetry.io/docs/instrumentation/php \ No newline at end of file +Documentation: https://opentelemetry.io/docs/instrumentation/php + +## Contributing + +This repository is a read-only git subtree split. +To contribute, please see the main [OpenTelemetry PHP monorepo](https://github.com/open-telemetry/opentelemetry-php). diff --git a/src/Context/README.md b/src/Context/README.md index 495065e25..4dfe0e23f 100644 --- a/src/Context/README.md +++ b/src/Context/README.md @@ -55,4 +55,9 @@ function bindContext(Closure $closure): Closure { } ``` +## Contributing + +This repository is a read-only git subtree split. +To contribute, please see the main [OpenTelemetry PHP monorepo](https://github.com/open-telemetry/opentelemetry-php). + [1]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/README.md#context diff --git a/src/Contrib/Grpc/README.md b/src/Contrib/Grpc/README.md index 67abe0d11..c34e3fe14 100644 --- a/src/Contrib/Grpc/README.md +++ b/src/Contrib/Grpc/README.md @@ -24,3 +24,8 @@ See https://github.com/open-telemetry/opentelemetry-php/blob/main/examples/trace $transport = (new \OpenTelemetry\Contrib\Grpc\GrpcTransportFactory())->create('http://collector:4317'); $exporter = new \OpenTelemetry\Contrib\Otlp\SpanExporter($transport); ``` + +## Contributing + +This repository is a read-only git subtree split. +To contribute, please see the main [OpenTelemetry PHP monorepo](https://github.com/open-telemetry/opentelemetry-php). diff --git a/src/Contrib/Otlp/README.md b/src/Contrib/Otlp/README.md index 727d20b46..a41349da0 100644 --- a/src/Contrib/Otlp/README.md +++ b/src/Contrib/Otlp/README.md @@ -38,3 +38,8 @@ makes exporting _significantly_ more performant. This can be easily installed wi ```shell pecl install protobuf ``` + +## Contributing + +This repository is a read-only git subtree split. +To contribute, please see the main [OpenTelemetry PHP monorepo](https://github.com/open-telemetry/opentelemetry-php). diff --git a/src/Contrib/Zipkin/README.md b/src/Contrib/Zipkin/README.md index 3d017fcf4..aa8490771 100644 --- a/src/Contrib/Zipkin/README.md +++ b/src/Contrib/Zipkin/README.md @@ -15,3 +15,8 @@ https://opentelemetry.io/docs/instrumentation/php/exporters/#zipkin ## Usage See https://github.com/open-telemetry/opentelemetry-php/blob/main/examples/traces/exporters/zipkin.php + +## Contributing + +This repository is a read-only git subtree split. +To contribute, please see the main [OpenTelemetry PHP monorepo](https://github.com/open-telemetry/opentelemetry-php). diff --git a/src/Extension/Propagator/B3/README.md b/src/Extension/Propagator/B3/README.md index 2007b4a44..05d9e3e14 100644 --- a/src/Extension/Propagator/B3/README.md +++ b/src/Extension/Propagator/B3/README.md @@ -24,4 +24,9 @@ B3Propagator::getB3MultiHeaderInstance() ``` Both of the above have `extract` and `inject` methods available to extract and inject respectively into the -header. \ No newline at end of file +header. + +## Contributing + +This repository is a read-only git subtree split. +To contribute, please see the main [OpenTelemetry PHP monorepo](https://github.com/open-telemetry/opentelemetry-php). diff --git a/src/SDK/README.md b/src/SDK/README.md index 12d096bb1..6346dc0f3 100644 --- a/src/SDK/README.md +++ b/src/SDK/README.md @@ -42,3 +42,8 @@ $meter = \OpenTelemetry\API\Globals::meterProvider()->getMeter('example'); If autoloading was not successful (or partially successful), no-op implementations of the above may be returned. See https://github.com/open-telemetry/opentelemetry-php/blob/main/examples/autoload_sdk.php for a more detailed example. + +## Contributing + +This repository is a read-only git subtree split. +To contribute, please see the main [OpenTelemetry PHP monorepo](https://github.com/open-telemetry/opentelemetry-php). diff --git a/src/SemConv/README.md b/src/SemConv/README.md index 8eda4810c..fc402f43d 100644 --- a/src/SemConv/README.md +++ b/src/SemConv/README.md @@ -15,3 +15,8 @@ See https://opentelemetry.io/docs/concepts/semantic-conventions/. ```shell composer require open-telemetry/sem-conv ``` + +## Contributing + +This repository is a read-only git subtree split. +To contribute, please see the main [OpenTelemetry PHP monorepo](https://github.com/open-telemetry/opentelemetry-php).