Skip to content

添加 AGENTS.md 与 CLAUDE.md 协作指南 - #19

Merged
FANNG1 merged 1 commit into
mainfrom
agent-docs
Jul 15, 2026
Merged

FANNG1 merged 1 commit into
mainfrom
agent-docs

Conversation

@FANNG1

@FANNG1 FANNG1 commented Jul 15, 2026

Copy link
Copy Markdown
Owner

背景

项目此前没有面向 AI 编码工具的协作指南,语言习惯和架构约定只存在于口头和已有代码的风格中,新会话/新工具需要反复重新交代。

改动

  • 新增 AGENTS.md,内容包括:
    • 语言约定:项目面向中文读者——代码注释用详细中文(模块 docstring 说明流水线角色与设计取舍,参考 image/udfs.py 的注释密度);PR 标题和描述用中文。
    • 项目概览:audio/image 双垂直管线、5 个 Stage、Daft + Lance on S3/MinIO 的技术栈和目录结构。
    • 硬性架构约定:媒体隔离(不做通用参数化管线)、数据 API 优先级(Daft → lance-ray → pylance)、analyze 行不丢弃(status 列标记失败)、Daft 执行参数必须经 configure_daft_runner() 显式接通(否则是死配置)、Lance/JSONL 写出受控、模型 UDF 的标准写法。
    • 常用命令与坑:uv、pytest、USE_RAY 切换、lance-ray 本地 dev checkout 不要顺手升级。
    • 提交与 PR 规范:不直接提交 main、PR 中文结构(背景→改动→验证)、提交前跑全量测试。
  • 新增 CLAUDE.md,仅一行 @AGENTS.md 导入,两类工具共享同一份内容,避免维护两份。

验证

纯文档改动,无代码变更;确认 Claude Code 的 @ 导入语法可正确引用 AGENTS.md。

Documents the Chinese-audience conventions (detailed Chinese code
comments, Chinese PR descriptions), the hard architecture rules
(media isolation, Daft-first data API priority, no-row-drop analyze
outputs, execution config must go through configure_daft_runner),
and the commit/PR workflow. CLAUDE.md imports AGENTS.md so both
tools share one source.
@FANNG1
FANNG1 merged commit 8d1ab2e into main Jul 15, 2026
1 check passed
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