docs: add AGENTS.md and CLAUDE.md for AI coding agents#313
Merged
Conversation
github-actions
Bot
added
the
documentation
AGENTS.md provides project context, build instructions, coding conventions, cross-repo workflow guidance, and commit standards for AI-assisted development. CLAUDE.md imports AGENTS.md via @import directive. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Inquisitor-201
force-pushed
the
docs/agents-md
branch
from
a380d9e to
7c64bc5
Compare
agicy
reviewed
May 26, 2026
Comment on lines
+43
to
+60
| ## Cross-Repository Work | ||
|
|
||
| This repo works with | ||
| [hvisor-tool](https://github.com/syswonder/hvisor-tool), which provides: | ||
|
|
||
| - Kernel module `driver/hvisor.ko` — zone lifecycle, image loading, VirtIO | ||
| communication | ||
| - Userspace binary `tools/hvisor` — zone management CLI, VirtIO device | ||
| backends | ||
|
|
||
| **When the task involves any of the following, ask the user for the local | ||
| path to hvisor-tool before proceeding:** | ||
|
|
||
| - Hypercall ABI (`hvisor_call` in `include/def.h`, hypercall codes) | ||
| - IOCTL interface (`include/hvisor.h`) | ||
| - VirtIO protocol (shared-memory request/response in `tools/virtio/`) | ||
| - Zone config structs (`include/zone_config.h`) | ||
|
|
Contributor
There was a problem hiding this comment.
Should we also include a link to the hvisor-book (https://github.com/syswonder/hvisor-book)?
Contributor
Author
There was a problem hiding this comment.
Should we also include a link to the hvisor-book (https://github.com/syswonder/hvisor-book)?
Yes, I will include this link later.
agicy
approved these changes
May 26, 2026
Contributor
agicy
left a comment
agicy
left a comment
There was a problem hiding this comment.
This is a great initiative to standardize AI-assisted development and provide precise project context. The guidelines are clear and accurate. Approved.
Inquisitor-201
force-pushed
the
docs/agents-md
branch
from
863a517 to
d1dced2
Compare
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.
Motivation
AI-assisted coding is becoming mainstream. As hvisor development increasingly relies on coding agents (Claude Code, GitHub Copilot, Codex, etc.), the lack of project-level context means every new session starts from scratch — agents need to rediscover the project structure, build system, and conventions, wasting tokens and rounds of conversation.
This PR introduces AGENTS.md, a cross-agent project guide that lets any compatible coding agent understand hvisor immediately.
Changes
AGENTS.md
Cross-agent project guide (compatible with Claude Code, Copilot, Codex, Cursor, and 20+ other tools), covering:
make ARCH=aarch64 BOARD=rk3588 LOG=LOG_INFOCLAUDE.md
A one-liner that reuses AGENTS.md content via Claude Code's @import mechanism, avoiding duplication.
References
Inspired by the vLLM project's AGENTS.md (precise commands, domain boundaries, AI attribution), but adapted for hvisor's smaller team and academic project context.