Skip to content

📝 Add critical patterns documentation to AGENTS.md#4183

Open
thomas-lebeau wants to merge 1 commit intomainfrom
thomas.lebeau/improve-agent-md
Open

📝 Add critical patterns documentation to AGENTS.md#4183
thomas-lebeau wants to merge 1 commit intomainfrom
thomas.lebeau/improve-agent-md

Conversation

@thomas-lebeau
Copy link
Collaborator

Motivation

Improve the AGENTS.md documentation with critical patterns learned from working with the codebase, so that AI agents (and developers) avoid common pitfalls.

Changes

Adds four new subsections to the Critical Patterns section of AGENTS.md:

  • Naming Conventions -- camelCase for internal code, snake_case/pascal_case only at serialization boundaries
  • TypeScript Patterns -- prefer type narrowing and discriminated unions over runtime assertions
  • Telemetry Usage -- clarify that addTelemetryUsage tracks static call-site info, not runtime state
  • Auto-Generated Files -- never manually edit files with DO NOT MODIFY IT BY HAND headers; change the upstream schema repo instead

Test instructions

Documentation-only change. Review the added sections in AGENTS.md for accuracy and completeness.

Checklist

  • Tested locally
  • Tested on staging
  • Added unit tests for this change.
  • Added e2e/integration tests for this change.
  • Updated documentation and/or relevant AGENTS.md file

- Add naming conventions (camelCase internally, snake_case at serialization boundary)

- Add TypeScript patterns (prefer type narrowing over runtime assertions)

- Add telemetry usage guidelines (track API calls, not runtime state)

- Add auto-generated files warning (never manually edit, upstream PR first)
@thomas-lebeau thomas-lebeau marked this pull request as ready for review February 13, 2026 16:01
@thomas-lebeau thomas-lebeau requested a review from a team as a code owner February 13, 2026 16:01
@cit-pr-commenter-54b7da
Copy link

Bundles Sizes Evolution

📦 Bundle Name Base Size Local Size 𝚫 𝚫% Status
Rum 169.44 KiB 169.44 KiB 0 B 0.00%
Rum Profiler 4.29 KiB 4.29 KiB 0 B 0.00%
Rum Recorder 24.61 KiB 24.61 KiB 0 B 0.00%
Logs 56.72 KiB 56.72 KiB 0 B 0.00%
Flagging 944 B 944 B 0 B 0.00%
Rum Slim 126.29 KiB 126.29 KiB 0 B 0.00%
Worker 23.63 KiB 23.63 KiB 0 B 0.00%
🚀 CPU Performance

Pending...

🧠 Memory Performance

Pending...

🔗 RealWorld

@datadog-official
Copy link

datadog-official bot commented Feb 13, 2026

✅ Tests

🎉 All green!

❄️ No new flaky tests detected
🧪 All tests passed

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

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: b86dba6 | Docs | Datadog PR Page | Was this helpful? Give us feedback!

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.

2 participants