Skip to content

RUM-17009: Clarify agent guidance for shared internal APIs - #4020

Merged
kikoveiga merged 1 commit into
developfrom
kikoveiga/RUM-17009/clarify-internal-api-guidance
Oct 21, 2026
Merged

kikoveiga merged 1 commit into
developfrom
kikoveiga/RUM-17009/clarify-internal-api-guidance

Conversation

@kikoveiga

Copy link
Copy Markdown
Collaborator

What does this PR do?

Adds one paragraph to AGENTS.md clarifying that shared types in dd-sdk-android-internal can be public for SDK access without becoming supported customer API. Changes still require checking SDK/cross-platform consumers and updating API snapshots; implementation does not eliminate runtime ABI concerns.

Motivation

During RUM-17009, this review finding on #4019 treated published internal types as customer API that must remain binary-compatible. Clarify the distinction for future agent reviews.

Additional Notes

Documentation only. git diff --check passes; no runtime tests needed.

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • Make sure you discussed the feature or bugfix with the maintaining team in an Issue
  • Make sure each commit and the PR mention the Issue number (cf the CONTRIBUTING doc)

@kikoveiga
kikoveiga requested review from a team as code owners October 21, 2026 14:30
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-21T14:41:56.716148Z bf60860 PR opened
🔒 Security Review ✅ Completed 2026-10-21T14:42:21.663967Z bf60860 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@datadog-datadog-prod-us1-2 datadog-datadog-prod-us1-2 Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bits Code Review: PASS

More details

The exception matches the repository’s dependency and visibility conventions while retaining consumer checks, API snapshot updates, and runtime ABI considerations for shared internal types.

Was this helpful? React 👍 or 👎

Open Bits AI session

🤖 Bits Code Review · Commit bf60860

@datadog-datadog-prod-us1-2

datadog-datadog-prod-us1-2 Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Tests

🎉 All green!

🧪 All tests passed
❄️ No new flaky tests detected

🔄 Datadog retried 1 test - 1 passed on retry View in Datadog

🎯 Code Coverage (details)
• Patch Coverage: 100.00%
• Overall Coverage: 71.86% (+0.00%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: bc9f8f3 | Docs | View more details | Give us feedback!

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
@kikoveiga
kikoveiga force-pushed the kikoveiga/RUM-17009/clarify-internal-api-guidance branch from bf60860 to bc9f8f3 Compare October 21, 2026 15:33
@kikoveiga
kikoveiga requested a review from ambushwork October 21, 2026 15:33
@kikoveiga
kikoveiga merged commit 208dff1 into develop Oct 21, 2026
27 checks passed
@kikoveiga
kikoveiga deleted the kikoveiga/RUM-17009/clarify-internal-api-guidance branch October 21, 2026 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants