docs(open_feature): address review feedback on coding guide#5989
Merged
Conversation
…n, root pointer Addresses review feedback from #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).
TonyCTHsu
added
the
AI Generated
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1b629cfa32
ℹ️ 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".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
The open_feature guide's Tool note tells Claude Code users to symlink AGENTS.md to CLAUDE.md in that directory; the gemspec filter only excluded AGENTS.md, so that symlink would ship in the gem.
A symlink is fragile (relative target resolves from the link's own directory, not the caller's cwd) and requires a manual per-contributor step. A committed one-line `@AGENTS.md` import works out of the box after clone and keeps a single source of truth.
🎉 All green!🧪 All tests passed 🎯 Code Coverage (details) 🔗 Commit SHA: 17682d0 | Docs | Datadog PR Page | Give us feedback! |
The Types section never stated the file-pairing requirement, and the Style section had no corresponding "Must follow" bullet.
Splits the combined size/description bullet into two with clear boundaries, links every Must-follow item to its detail section for consistency, and adds an explicit test-coverage requirement backed by a new Tests entry under Pull requests.
Backs the new Must-follow bullet with detail on when a change is customer-observable provider behavior (Yes.) versus internal (None.).
Strech
approved these changes
Jul 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Addresses outstanding review feedback on the OpenFeature coding guide from #5968, and sharpens the guide's own PR-related rules (test coverage requirement, clearer size/description boundaries). Also fixes the gemspec/release-spec exclusion so nested
AGENTS.md/CLAUDE.mdfiles don't ship in the packaged gem.Motivation:
#5968 already merged with approvals, but reviewers left actionable feedback afterward that this PR resolves without having blocked that merge. The gemspec fix addresses an automated review comment: the nested guide files introduced here would otherwise ship in the gem.
Change log entry
None.
Additional Notes:
CLAUDE.mdis committed (not a per-contributor symlink) so it works out of the box after clone, withAGENTS.mdas the single source of truth via Claude Code's@pathimport syntax.How to test the change?
Documentation only for the guide changes. For the gemspec/spec changes:
bundle exec rspec spec/datadog/release_gem_spec.rbandruby -e "puts Gem::Specification.load('datadog.gemspec').files.grep(/CLAUDE|AGENTS/)"(expect empty output).