Repository navigation
docs: add AGENTS.md with PR quality rules - #199
Merged
Merged
Conversation
Add guidance for coding agents and review bots on PR size, duplicate tests, defensive checks, and settings shared with the Lambda Extension and the Go Agent. Stop ignoring /AGENTS.md so the file can be committed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Follow the Lambda Extension setup: commit CLAUDE.md, and ignore /CLAUDE_PERSONAL.md for personal instructions. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
lym953
marked this pull request as ready for review
October 29, 2026 14:59
lym953
requested review from
apiarian-datadog and
litianningdatadog
and removed request for
a team
October 29, 2026 14:59
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Comment on lines
+20
to
+21
| - Do not add a defensive check unless you can name the input that makes it fail. For example, | ||
| do not check that an index is in range when the function that returns it cannot return an |
Contributor
There was a problem hiding this comment.
is that something specific to this repo?
Contributor
Author
There was a problem hiding this comment.
No. It's copied from lambda extension repo. Let me delete it for now. We can consider adding it when we actually see the problem.
litianningdatadog
left a comment
litianningdatadog
left a comment
Contributor
There was a problem hiding this comment.
Overall, I’m okay with it, but generic content may offer limited value in the long run.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
duncanista
approved these changes
Oct 29, 2026
litianningdatadog
approved these changes
Oct 29, 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
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.
Problem
Coding agents and review bots in this repository have no guidance on PR quality. The only instruction file is
.github/copilot-instructions.md, and it covers only security.On #169, the author ran several rounds of bot review, and they did not report the problems below. Our own review with Claude Code found them. That review used review rules from a personal configuration:
This PR
Adds
AGENTS.mdwith rules for code style, settings, tests, PR size and reviews. Three rules come from theAGENTS.mdfile of the Lambda Extension:The other rules come from the review of [Traces] Add error sampling with opt-in tracer-drop rescue #169.
These rules are a starting point. We can change them and add more as we learn what helps the reviews.
Adds
CLAUDE.md, which loadsAGENTS.mdandCLAUDE_PERSONAL.md. This is the same setup as the Lambda Extension. Claude Code readsCLAUDE.md, so it gets the rules inAGENTS.md.Changes
.gitignore. It no longer ignores/AGENTS.mdand/CLAUDE.md, so that the two files can be committed. It ignores/CLAUDE_PERSONAL.md, so that each person can keep personal instructions in that file.Testing
This PR changes only documentation. I did not run a bot review with the new file.
If you have a local
CLAUDE.mdBefore this PR,
.gitignoreignored/CLAUDE.md, so some people keep a localCLAUDE.mdwith personal instructions. After this PR merges, a pull fails while that file is in the repository root. Rename your file toCLAUDE_PERSONAL.mdbefore you pull. The committedCLAUDE.mdloads it.The same applies to a local
AGENTS.md. Move its content toCLAUDE_PERSONAL.mdtoo.🤖 Generated with Claude Code