Add AGENTS.md and update CLAUDE.md with project documentation#23
Add AGENTS.md and update CLAUDE.md with project documentation#23UdaraWickramarathne wants to merge 2 commits into
Conversation
|
|
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 25 minutes and 29 seconds. ⌛ 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. WalkthroughTwo new documentation files were introduced to the repository. AGENTS.md defines the repository structure, contribution conventions, and working guidelines for the Choreo VS Code extension. CLAUDE.md directs readers to AGENTS.md for complete documentation. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@AGENTS.md`:
- Around line 25-27: AGENTS.md claims "There are no build or lint commands"
while CLAUDE.md references "build/test commands in this file," causing a
contradiction; reconcile by either removing the misleading reference in
CLAUDE.md or documenting real commands in AGENTS.md. Locate the referenced text
in AGENTS.md ("There are no build or lint commands") and the pointer in
CLAUDE.md ("build/test commands in this file") and update one of them: if no
build system exists, edit CLAUDE.md to remove or reword the pointer to
AGENTS.md; if build/test scripts exist, add a concise "Build and test commands"
section to AGENTS.md listing the commands and where to run them. Ensure both
files consistently reflect the repository's actual status.
- Around line 5-8: The "Upstream" line in AGENTS.md currently points to
https://github.com/wso2/choreo-vscode creating a circular reference; edit the
AGENTS.md entry that begins with "Upstream:" to either remove that line entirely
(if this repo is the canonical source) or replace the URL with the correct
external upstream repository URL, and ensure the surrounding text ("This is a
documentation-only repository...") remains accurate; look for the literal
"Upstream:" string in AGENTS.md to locate and change the text.
In `@CLAUDE.md`:
- Around line 3-4: The CLAUDE.md reference claims "Read AGENTS.md for repository
overview, architecture, build/test commands, key files, and development
guidelines" which contradicts AGENTS.md (line 27: "There are no build or lint
commands"); either remove "build/test commands" from the CLAUDE.md sentence that
begins "**Full documentation is in [AGENTS.md](./AGENTS.md).**" or update
AGENTS.md to actually document build/test commands—pick one and make the texts
consistent (edit the CLAUDE.md sentence or the AGENTS.md content accordingly).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: ea868dee-fa6c-497f-914c-2dd0d062b6aa
📒 Files selected for processing (2)
AGENTS.mdCLAUDE.md
| This is a **documentation-only repository** for the [Choreo VS Code extension](https://marketplace.visualstudio.com/items?itemName=WSO2.choreo). It contains no source code, build system, or tests. The actual extension source code lives in the upstream WSO2 repository. | ||
|
|
||
| - **Upstream**: https://github.com/wso2/choreo-vscode | ||
| - **License**: Apache 2.0 (WSO2 LLC) |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify if this repository contains source code, build configs, or tests
echo "=== Checking for source code files ==="
fd -e ts -e js -e tsx -e jsx --max-depth 3 | head -20
echo -e "\n=== Checking for build configuration ==="
fd -e json --max-depth 2 | grep -E '(package|tsconfig|webpack|rollup|vite)' | head -10
echo -e "\n=== Checking for test files/directories ==="
fd -t d -g '*test*' --max-depth 3
fd -e ts -e js -g '*test*' --max-depth 3 | head -10
echo -e "\n=== Checking directory structure ==="
tree -L 2 -d -I 'node_modules|dist|out|.git' | head -30Repository: wso2/choreo-vscode
Length of output: 303
🏁 Script executed:
#!/bin/bash
# Get full AGENTS.md content
echo "=== Full AGENTS.md content ==="
cat -n AGENTS.md
echo -e "\n=== Repository root files ==="
ls -la | grep -v '^d'
echo -e "\n=== Check for README or similar ==="
fd -e md --max-depth 1
echo -e "\n=== Git origin (if available) ==="
git config --get remote.origin.url 2>/dev/null || echo "Not a git repo or origin not set"Repository: wso2/choreo-vscode
Length of output: 2545
Fix circular upstream reference in line 7.
Line 7 claims the upstream source is https://github.com/wso2/choreo-vscode, but this file is in that exact repository (confirmed by git origin). This creates a circular reference.
Either:
- Remove the "Upstream" line if wso2/choreo-vscode is the actual source repository, or
- Update the URL to point to a different upstream repository if this documentation repository is intended to be separate
The characterization of this repository as "documentation-only" with "no source code, build system, or tests" is accurate.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@AGENTS.md` around lines 5 - 8, The "Upstream" line in AGENTS.md currently
points to https://github.com/wso2/choreo-vscode creating a circular reference;
edit the AGENTS.md entry that begins with "Upstream:" to either remove that line
entirely (if this repo is the canonical source) or replace the URL with the
correct external upstream repository URL, and ensure the surrounding text ("This
is a documentation-only repository...") remains accurate; look for the literal
"Upstream:" string in AGENTS.md to locate and change the text.
| ## Working in This Repo | ||
|
|
||
| All changes here are documentation changes (Markdown files, images, screenshots). There are no build or lint commands. When adding or updating screenshots, place them in the appropriate `docs/` subdirectory following the existing structure. |
There was a problem hiding this comment.
Inconsistency: Claims no build/lint commands but CLAUDE.md references them.
Line 27 states "There are no build or lint commands," but CLAUDE.md line 4 directs readers to "build/test commands" in this file. This creates an internal documentation contradiction.
If the repository truly has no build system, CLAUDE.md should be updated to remove the misleading reference. If the repository does have build commands, AGENTS.md needs to document them.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@AGENTS.md` around lines 25 - 27, AGENTS.md claims "There are no build or lint
commands" while CLAUDE.md references "build/test commands in this file," causing
a contradiction; reconcile by either removing the misleading reference in
CLAUDE.md or documenting real commands in AGENTS.md. Locate the referenced text
in AGENTS.md ("There are no build or lint commands") and the pointer in
CLAUDE.md ("build/test commands in this file") and update one of them: if no
build system exists, edit CLAUDE.md to remove or reword the pointer to
AGENTS.md; if build/test scripts exist, add a concise "Build and test commands"
section to AGENTS.md listing the commands and where to run them. Ensure both
files consistently reflect the repository's actual status.
2 participants
Documentation Setup
Adds standard AI agent documentation files to improve developer onboarding
and assist AI-assisted development workflows.
Changes
AGENTS.md– Comprehensive project documentation including architectureoverview, module layout, build/test commands, request flow, database setup,
testing patterns, CI/CD pipeline, and PR conventions.
CLAUDE.md– Updated to referenceAGENTS.mdas the primarydocumentation source for this repository.
Why
These files provide structured context for both human developers and AI coding
assistants, reducing onboarding time and ensuring consistent development practices.
Summary by CodeRabbit