Skip to content

doc: Add AI agent guidance for the project#4920

Open
qinxuye wants to merge 2 commits into
xorbitsai:mainfrom
qinxuye:docs/add-agent-guidance
Open

doc: Add AI agent guidance for the project#4920
qinxuye wants to merge 2 commits into
xorbitsai:mainfrom
qinxuye:docs/add-agent-guidance

Conversation

@qinxuye
Copy link
Copy Markdown
Contributor

@qinxuye qinxuye commented May 18, 2026

Summary

  • Add a root AGENTS.md with project-specific guidance for AI coding agents
  • Add CLAUDE.md as a symlink to AGENTS.md for Claude-compatible tooling
  • Allow AGENTS.md and CLAUDE.md through the repository markdown ignore rule

Tests

  • git diff --check
  • pre-commit hooks during commit (skipped; no matching tracked hook files)

@XprobeBot XprobeBot added the documentation Improvements or additions to documentation label May 18, 2026
@XprobeBot XprobeBot added this to the v2.x milestone May 18, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces AGENTS.md, a comprehensive guide for AI coding agents working on the Xinference project, and updates .gitignore to ensure it and CLAUDE.md are tracked. Feedback includes improving the document title for clarity, using npx for Prettier commands to ensure environment portability, and correcting CLAUDE.md to be a proper filesystem symbolic link rather than a plain text file.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread CLAUDE.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants