docs(open_feature): add LLM coding guide for FFE contributors#5968
Conversation
Adds a scoped AGENTS.md under lib/datadog/open_feature/ covering naming, comments, methods, error handling, RBS types, tests, concurrency, repo idioms, structure, and style — each with concrete good/bad examples. Includes PR size warning, PR description guidance using the repo template, and dead code definition with examples. Scoped to this subtree so it adds zero context overhead for maintainers working elsewhere in the repo.
🎉 All green!🧪 All tests passed 🔄 Datadog auto-retried 1 job - 0 passed on retry 🎯 Code Coverage (details) 🔗 Commit SHA: 709537d | Docs | Datadog PR Page | Give us feedback! |
y9v
left a comment
There was a problem hiding this comment.
awesome guide! Thank you, this will save us all a lot of time
BenchmarksBenchmark execution time: 2026-06-30 12:17:11 Comparing candidate commit 4dee0fd in PR branch Found 0 performance improvements and 0 performance regressions! Performance is the same for 48 metrics, 1 unstable metrics.
|
anmarchenko
left a comment
There was a problem hiding this comment.
I think this is a very good guidance! we can adopt it for the whole library as well
leoromanovsky
left a comment
There was a problem hiding this comment.
Approving, as I appreciate the direction this is going. I haven't tested it out yet, but looking forward to my next contribution and seeing its effect.
|
Opened #5989 to address the 4 outstanding review threads on this PR (blank line after the guard clause, Zeitwerk file-structure section, root Given #5968 already has 5 approvals and the open threads are non-blocking for this docs-only change, planning to merge this PR once #5989 is up for review — the follow-up PR is where the review feedback gets addressed and re-reviewed. |
…n, root pointer Addresses review feedback from DataDog#5968: fix blank line after guard clause (Strech), add Zeitwerk file-structure conventions section (Strech), link the nested guide from the root AGENTS.md for tools that only walk down from repo root (leoromanovsky), and trim the guide toward ~200 lines with a must-follow checklist up front and examples moved lower (leoromanovsky).
What does this PR do?
Adds a scoped
AGENTS.mdcoding guide underlib/datadog/open_feature/for contributors and their AI coding tools working in that subtree.Motivation:
The OpenFeature area receives LLM-assisted contributions from a team without a dedicated Ruby engineer. Review time is spent correcting conventions rather than evaluating design and correctness. This guide codifies the conventions upfront so generated code arrives closer to the bar we hold everywhere else in the tracer.
Change log entry
None.
Additional Notes:
The file is scoped to
lib/datadog/open_feature/so it loads lazily and adds zero context overhead for maintainers working elsewhere. Each rule is grounded in a real finding from this codebase; the guide is intended to grow as new patterns emerge.How to test the change?
Documentation only — no code changes.