diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d97c3444f8..32a585dc05 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,24 +33,35 @@ This project hosts the following modules: - `features/dd-sdk-android-session-replay-compose`: an extension for Session Replay to integrate with the Jetpack Compose; - `features/dd-sdk-android-session-replay-material`: an extension for Session Replay to integrate with the Material Design library; - `features/dd-sdk-android-trace`: a library to measure performance of operations locally; - - `features/dd-sdk-android-trace-otel`: an extension of Trace library to integrate with OpenTelemetry; + - `features/dd-sdk-android-trace-api`: a library containing API definitions for the Trace library; + - `features/dd-sdk-android-trace-internal`: a library containing internal classes for the Trace library; + - `features/dd-sdk-android-trace-otel`: an extension of Trace library to integrate with [OpenTelemetry](https://opentelemetry.io/); - `features/dd-sdk-android-webview`: a library to forward logs and RUM events captured in a webview to be linked with the mobile session; - `integrations/***`: a set of libraries integrating Datadog products in third party libraries: - `integrations/dd-sdk-android-coil`: a lightweight library providing a bridge integration between Datadog SDK and [Coil](https://coil-kt.github.io/coil/); - `integrations/dd-sdk-android-compose`: a lightweight library providing a bridge integration between Datadog SDK and [Jetpack Compose](https://developer.android.com/jetpack/compose); - `integrations/dd-sdk-android-fresco`: a lightweight library providing a bridge integration between Datadog SDK and [Fresco](https://frescolib.org/); + - `integrations/dd-sdk-android-glide`: a lightweight library providing a bridge integration between Datadog SDK and [Glide](https://bumptech.github.io/glide/); - `integrations/dd-sdk-android-okhttp`: a lightweight library providing an instrumentation for [OkHttp](https://square.github.io/okhttp/); - - `integrations/dd-sdk-android-okhttp-otel`: a lightweight library a support of OpenTelemetry for the [OkHttp](https://square.github.io/okhttp/) instrumentation; + - `integrations/dd-sdk-android-okhttp-otel`: a lightweight library providing a support of [OpenTelemetry](https://opentelemetry.io/) for the [OkHttp](https://square.github.io/okhttp/) instrumentation; + - `integrations/dd-sdk-android-rum-coroutines`: a set of extensions for Kotlin Coroutines to ease the work with the RUM library; - `integrations/dd-sdk-android-rx`: a lightweight library providing a bridge integration between Datadog SDK and [RxJava](https://github.com/ReactiveX/RxJava); - `integrations/dd-sdk-android-sqldelight`: a lightweight library providing a bridge integration between Datadog SDK and [SQLDelight](https://cashapp.github.io/sqldelight/); + - `integrations/dd-sdk-android-timber`: a lightweight library providing a bridge integration between Datadog SDK and [Timber](https://github.com/JakeWharton/timber); - `integrations/dd-sdk-android-tv`: a lightweight library providing extensions for [Android TV](https://www.android.com/tv/) - `integrations/dd-sdk-android-trace-coroutines`: a set of extensions for Kotlin Coroutines to ease the work with the Trace library; - - `integrations/dd-sdk-android-rum-coroutines`: a set of extensions for Kotlin Coroutines to ease the work with the RUM library; - - `integrations/dd-sdk-android-glide`: a lightweight library providing a bridge integration between Datadog SDK and [Glide](https://bumptech.github.io/glide/); - - `integrations/dd-sdk-android-timber`: a lightweight library providing a bridge integration between Datadog SDK and [Timber](https://github.com/JakeWharton/timber); - `instrumented/***`: a set of modules used to run instrumented tests: - `instrumented/integration`: a test module with integration tests using Espresso; - - `tools/*`: a set of modules used to extend the tools we use in our workflow: + - `reliability/***`: a set of modules used to run integration tests: + - `reliability/core-it`: a set of integration tests for the Datadog SDK core library; + - `reliability/single-fit/logs`: a set of integration tests for the Logs library; + - `reliability/single-fit/okhttp`: a set of integration tests for [OkHttp](https://square.github.io/okhttp/) instrumentation; + - `reliability/single-fit/rum`: a set of integration tests for the RUM library; + - `reliability/single-fit/trace`: a set of integration tests for the Trace library; + - `reliability/stub-core`: a set of stubs for Datadog SDK core; + - `reliability/stub-feature`: a set of stubs for Datadog SDK feature APIs; + - `tools/***`: a set of modules used to extend the tools we use in our workflow: + - `tools/benchmark`: a code to benchmark SDK performance; - `tools/detekt`: a few custom [Detekt](https://github.com/arturbosch/detekt) static analysis rules; - `tools/lint`: a custom [Lint](https://developer.android.com/studio/write/lint) static analysis rule; - `tools/noopfactory`: an annotation processor generating no-op implementation of interfaces;