Skip to content

Commit a213cc7

Browse files
authored
Merge pull request #2762 from DataDog/nogorodnikov/update-contributing-doc-with-missing-modules
Update `CONTRIBUTING` doc with missing modules
2 parents e72f453 + d992252 commit a213cc7

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,28 @@ In addition, to be able to run the static analysis tools locally, you should run
2424
This project hosts the following modules:
2525

2626
- `dd-sdk-android-core`: the main library implementing the core functionality of SDK (storage and upload of data, core APIs);
27+
- `dd-sdk-android-internal`: a library providing internal APIs, classes and utilities shared by the SDK modules;
2728
- `features/***`: a set of libraries implementing Datadog products:
2829
- `features/dd-sdk-android-logs`: a library to send logs to Datadog;
2930
- `features/dd-sdk-android-rum`: a library to track user navigation and interaction;
3031
- `features/dd-sdk-android-ndk`: a lightweight library to track crashes from NDK libraries;
3132
- `features/dd-sdk-android-session-replay`: a library to capture the window content;
33+
- `features/dd-sdk-android-session-replay-compose`: an extension for Session Replay to integrate with the Jetpack Compose;
3234
- `features/dd-sdk-android-session-replay-material`: an extension for Session Replay to integrate with the Material Design library;
33-
- `features/dd-sdk-android-session-trace`: a library to measure performance of operations locally;
34-
- `features/dd-sdk-android-session-webview`: a library to forward logs and RUM events captured in a webview to be linked with the mobile session;
35+
- `features/dd-sdk-android-trace`: a library to measure performance of operations locally;
36+
- `features/dd-sdk-android-trace-otel`: an extension of Trace library to integrate with OpenTelemetry;
37+
- `features/dd-sdk-android-webview`: a library to forward logs and RUM events captured in a webview to be linked with the mobile session;
3538
- `integrations/***`: a set of libraries integrating Datadog products in third party libraries:
3639
- `integrations/dd-sdk-android-coil`: a lightweight library providing a bridge integration between Datadog SDK and [Coil](https://coil-kt.github.io/coil/);
3740
- `integrations/dd-sdk-android-compose`: a lightweight library providing a bridge integration between Datadog SDK and [Jetpack Compose](https://developer.android.com/jetpack/compose);
3841
- `integrations/dd-sdk-android-fresco`: a lightweight library providing a bridge integration between Datadog SDK and [Fresco](https://frescolib.org/);
3942
- `integrations/dd-sdk-android-okhttp`: a lightweight library providing an instrumentation for [OkHttp](https://square.github.io/okhttp/);
43+
- `integrations/dd-sdk-android-okhttp-otel`: a lightweight library a support of OpenTelemetry for the [OkHttp](https://square.github.io/okhttp/) instrumentation;
4044
- `integrations/dd-sdk-android-rx`: a lightweight library providing a bridge integration between Datadog SDK and [RxJava](https://github.com/ReactiveX/RxJava);
4145
- `integrations/dd-sdk-android-sqldelight`: a lightweight library providing a bridge integration between Datadog SDK and [SQLDelight](https://cashapp.github.io/sqldelight/);
4246
- `integrations/dd-sdk-android-tv`: a lightweight library providing extensions for [Android TV](https://www.android.com/tv/)
43-
- `integrations/dd-sdk-android-ktx`: a set of Kotlin extensions to make the Datadog SDK more Kotlin friendly;
47+
- `integrations/dd-sdk-android-trace-coroutines`: a set of extensions for Kotlin Coroutines to ease the work with the Trace library;
48+
- `integrations/dd-sdk-android-rum-coroutines`: a set of extensions for Kotlin Coroutines to ease the work with the RUM library;
4449
- `integrations/dd-sdk-android-glide`: a lightweight library providing a bridge integration between Datadog SDK and [Glide](https://bumptech.github.io/glide/);
4550
- `integrations/dd-sdk-android-timber`: a lightweight library providing a bridge integration between Datadog SDK and [Timber](https://github.com/JakeWharton/timber);
4651
- `instrumented/***`: a set of modules used to run instrumented tests:
@@ -52,8 +57,11 @@ This project hosts the following modules:
5257
- `tools/unit`: a utility library with code to help writing unit tests;
5358
- `sample/***`: a few sample applications showcasing how to use the library features in production code;
5459
- `sample/kotlin`: a sample mobile application;
55-
- `sample/vendor-lib`: a sample android library, to showcase vendors using Datadog in a host app also using Datadog;
56-
- `sample/wear`: a sample watch application;
60+
- `sample/vendor-lib`: a sample Android library, to showcase vendors using Datadog in a host app also using Datadog;
61+
- `sample/wear`: a sample Wear OS application;
62+
- `sample/automotive`: a sample Automotive OS application;
63+
- `sample/tv`: a sample Android TV OS application;
64+
- `sample/benchmark`: a sample application to collect SDK performance metrics;
5765

5866
### Building the SDK
5967

local_ci.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ if [[ $CLEANUP == 1 ]]; then
102102
rm -rf features/dd-sdk-android-ndk/build/
103103
rm -rf features/dd-sdk-android-rum/build/
104104
rm -rf features/dd-sdk-android-session-replay/build/
105+
rm -rf features/dd-sdk-android-session-replay-compose/build/
105106
rm -rf features/dd-sdk-android-session-replay-material/build/
106107
rm -rf features/dd-sdk-android-trace/build/
107108
rm -rf features/dd-sdk-android-trace-otel/build/

0 commit comments

Comments
 (0)