Skip to content

docs: add repository agent guide#28

Merged
princeofscale merged 2 commits into
mainfrom
docs/agent-guide
Jul 14, 2026
Merged

docs: add repository agent guide#28
princeofscale merged 2 commits into
mainfrom
docs/agent-guide

Conversation

@princeofscale

@princeofscale princeofscale commented Jul 14, 2026

Copy link
Copy Markdown
Owner

Summary

  • add a root AGENTS.md for AI coding agents
  • document architecture, working rules, validation, docs, and release flow
  • keep credentials and generated artifacts out of commits

Validation

  • git diff --check

Summary by CodeRabbit

  • Documentation
    • Added a repository operations guide covering development practices, validation steps, documentation standards, and release procedures.

@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Adds AGENTS.md as the repository’s primary guide for AI coding agents, covering project structure, working rules, validation commands, documentation alignment, and release procedures.

Changes

Agent Guidance

Layer / File(s) Summary
Repository operations and release guidance
AGENTS.md
Defines the repository map, editing and compatibility rules, local validation commands, documentation expectations, and release checklist.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Poem

I’m a rabbit with a guide in my paws,
Hopping through rules, checks, and clauses.
With releases aligned and secrets kept tight,
The agents can burrow and build just right.
Sniff, test, tag—then thump with delight!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding a repository agent guide in AGENTS.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/agent-guide

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@princeofscale
princeofscale merged commit cedf29c into main Jul 14, 2026
7 of 8 checks passed

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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.

Inline comments:
In `@AGENTS.md`:
- Around line 50-51: Update the plugin validation commands in AGENTS.md to use
the package.json-defined scripts test:plugin:smoke and test:plugin:runtime
instead of plugin:smoke and plugin:runtime-smoke.
🪄 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 Plus

Run ID: b3fbf623-ee86-4283-8b53-d57b3c10a805

📥 Commits

Reviewing files that changed from the base of the PR and between e05b4ed and 296ec15.

📒 Files selected for processing (1)
  • AGENTS.md

Comment thread AGENTS.md
Comment on lines +50 to +51
npm run plugin:smoke
npm run plugin:runtime-smoke

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Use the repository’s actual plugin validation script names.

The supplied package.json defines test:plugin:smoke and test:plugin:runtime; these commands will fail as written:

-npm run plugin:smoke
-npm run plugin:runtime-smoke
+npm run test:plugin:smoke
+npm run test:plugin:runtime
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
npm run plugin:smoke
npm run plugin:runtime-smoke
npm run test:plugin:smoke
npm run test:plugin:runtime
🤖 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 50 - 51, Update the plugin validation commands in
AGENTS.md to use the package.json-defined scripts test:plugin:smoke and
test:plugin:runtime instead of plugin:smoke and plugin:runtime-smoke.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant