docs: expand and reorganize AGENTS.md across packages#459
Conversation
- Root AGENTS.md: add a Repository Layout table near the top, add a "Before Committing Python Changes" section requiring `uv run ruff check`, `uv run ruff format`, and `uv run pyright` (with the rationale that `uvx` strips the project venv and breaks pyright import resolution), and trim the duplicated "Summary → Preferred Workflow" block that restated the body. - otdf-local/AGENTS.md: mark the manual-keys YAML block as an emergency fallback that may drift from the current platform schema. - xtest/AGENTS.md (new): test-suite layout, custom pytest options table, audit-log fixture quick reference, authoring guidance. - xtest/CLAUDE.md: symlink to AGENTS.md, matching repo convention. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughThis PR updates developer onboarding documentation across four files. The root AGENTS.md gains a repository layout table and a new pre-commit checks section, replacing end-of-document workflow details with a brief closing note. A new xtest/AGENTS.md guide documents the cross-client integration test suite structure, fixtures, authoring rules, and SDK CLI abstraction. otdf-local/AGENTS.md clarifies its manual configuration as an emergency fallback. xtest/CLAUDE.md is added as a reference file. ChangesDeveloper Onboarding and Test Guidance
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request reorganizes documentation for AI agents by updating the root AGENTS.md with a repository layout and mandatory pre-commit Python checks, while also introducing a comprehensive guide for the xtest integration suite. Additionally, it refines manual configuration warnings in otdf-local/AGENTS.md. Feedback from the review suggests ensuring table consistency in the main guide and correcting a forward-looking reference to a documentation file that has not yet been created.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
AGENTS.md (1)
5-14: 💤 Low valueConsider filling the empty cell in the table for consistency.
The third column on line 13 (for
xtest/sdk/{go,java,js}/dist/) is empty. Since this row describes build artifacts rather than source directories, consider adding "n/a" or "—" to maintain table structure consistency.📝 Proposed table fix
-| `xtest/sdk/{go,java,js}/dist/` | Built SDK CLI wrappers, produced by `otdf-sdk-mgr install` (or by `cd xtest/sdk && make` for source builds) | | +| `xtest/sdk/{go,java,js}/dist/` | Built SDK CLI wrappers, produced by `otdf-sdk-mgr install` (or by `cd xtest/sdk && make` for source builds) | n/a |🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@AGENTS.md` around lines 5 - 14, The table row for `xtest/sdk/{go,java,js}/dist/` in AGENTS.md has an empty third column; update that cell to a consistent marker like "n/a" or "—" to indicate build artifacts rather than a source directory so the table remains uniform, e.g., change the empty entry in the row referencing `xtest/sdk/{go,java,js}/dist/` to "n/a".
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@AGENTS.md`:
- Around line 5-14: The table row for `xtest/sdk/{go,java,js}/dist/` in
AGENTS.md has an empty third column; update that cell to a consistent marker
like "n/a" or "—" to indicate build artifacts rather than a source directory so
the table remains uniform, e.g., change the empty entry in the row referencing
`xtest/sdk/{go,java,js}/dist/` to "n/a".
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: bd0c378f-0e93-4898-a8ba-e583b7efe9c7
📒 Files selected for processing (4)
AGENTS.mdotdf-local/AGENTS.mdxtest/AGENTS.mdxtest/CLAUDE.md
dmihalcik-virtru
changed the title
- Root AGENTS.md: collapse the duplicated Custom pytest Options and Audit Log Assertions sections into a summary that delegates to xtest/AGENTS.md (the operational knobs live there). Net 41 lines removed. - Add the missing `eval $(uv run otdf-local env)` step to the Environment Management quick start so the default audit-log assertions actually have the env vars they require. - Replace the stale test-file list with a pointer to xtest/AGENTS.md, which has the canonical and current list (adds test_audit_logs.py, test_pqc.py). - Drop the truncated "Base Key Behavior" heading (one-sentence orphan). - Drop the generic "Before Making Changes" subsection and "Common Pitfalls" list — both were low-signal restatements of the body. - Closing Note now references otdf-sdk-mgr/README.md (the file that exists) instead of the nonexistent otdf-sdk-mgr/AGENTS.md. - Fill empty cell in the Repository Layout table row for xtest/sdk/.../dist/ with "n/a" (PR review comment, both gemini and coderabbitai flagged it). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
X-Test Failure Report |
2 participants
Summary
Improves the agent-facing documentation across the repository so future Claude Code sessions land on accurate context faster. All changes are docs-only — no code touched.
AGENTS.md: new Repository Layout table at the top; new "Before Committing Python Changes" section requiringuv run ruff check,uv run ruff format, anduv run pyright, with the rationale thatuvxstrips the project venv and breaks pyright import resolution; trimmed the duplicated "Summary → Preferred Workflow" block.otdf-local/AGENTS.md: flagged the manual-keys YAML block as an emergency fallback that may drift from the current platform schema.xtest/AGENTS.md(new): test-suite layout, custom pytest options reference, audit-log fixture quick reference (--no-audit-logsvsDISABLE_AUDIT_ASSERTIONS), and test-authoring guidance.xtest/CLAUDE.mdsymlinks to it, matching the root convention.Scoped intentionally to content that's accurate on
maintoday. A follow-up PR will addotdf-sdk-mgr/AGENTS.md(covering the platform installer and scenario workflows) once #451 merges.Test plan
git diff --statgrepfor forward references to feature-branch-only code (platform_installer,cli_scenario,install platform,install scenario) returns no matches in these filesmaintoday🤖 Generated with Claude Code
Summary by CodeRabbit