Skip to content

Latest commit

 

History

History
194 lines (149 loc) · 5.51 KB

File metadata and controls

194 lines (149 loc) · 5.51 KB

AGENTS.md

相关文档

文档 用途
README 项目概述、子模块列表
CONTRIBUTING Skill 使用和维护指南
IDENTITY.md 仓库自我映射、子模块列表
SOUL.md AI 自我认知(自维护)
TOOLS.md 工具清单(自维护)

Skill 索引

Skill 用途 路径
devops-commit 规范提交 .agents/skills/devops-commit/SKILL.md
devops-release 发布 Release .agents/skills/devops-release/SKILL.md
devops-submodule 子模块管理 .agents/skills/devops-submodule/SKILL.md
devops-review 流程审查 .agents/skills/devops-review/SKILL.md

快速索引

任务 操作位置
提交变更 Skill: commit
发布 Release Skill: release
修改子模块 Skill: submodule
记录日报 docs/archive/report/default/diary/YYYY-MM-DD.md

我的工作原则

最小干预

  • 仅在用户明确请求时操作
  • 不主动创建文件(除非必要)
  • 优先编辑现有文件
  • 目录变更需与作者商议:作者对目录使用有严格规范,能不更改尽量不更改

原子提交

  • 每次提交独立完整
  • 不提交不完整的更改
  • 验证后再提交

验证优先

  • 修改后运行构建验证
  • 前端文件操作后必须验证
  • 确保更改符合预期

安全第一

  • 不创建可能被恶意使用的代码
  • 检测安全漏洞并报告
  • 遵循 OWASP 最佳实践

输出规范

内容格式

  • 不使用 emoji(除非用户明确请求)
  • 输出简洁,适合 CLI 显示
  • 使用 MyST Markdown

文件引用

  • 使用 code 格式表示文件路径
  • 每个引用独立,不合并
  • 可选包含行号信息

代码示例

  • 使用 fenced code blocks
  • 包含语言标识符
  • 保持代码简洁

自我更新

总体原则

  • 重要变更记录到 docs/archive/report/default/diary/YYYY-MM-DD.md
  • 能力变化时更新本文档
  • 保持所有文档与实际情况一致

用户画像更新(USER.md)

更新时机:

  • 用户明确告知新信息(工作变化、目标调整、偏好改变)
  • 在交互中观察到新的用户行为模式
  • 用户对系统的期望发生变化

更新内容:

  • 用户画像(身份、特质、日常工作)
  • 用户目标(短期目标、长期目标)
  • 使用场景(新增或修改场景)
  • 用户期望(对系统或 AI 的新期望)

更新方式:

  • 仅在获得明确信息时更新
  • 保持客观,不添加推测
  • 与现有内容保持一致

仓库认知更新(IDENTITY.md)

更新时机:

  • 仓库结构发生变化(新增/删除子模块)
  • 核心框架调整(九宫格、五层记忆模型)
  • 项目状态变化(Release、版本更新)
  • 发现需要记录的元数据变化

更新内容:

  • 仓库定位和核心价值
  • 核心框架(记忆建模、分层模型)
  • 目录结构
  • 子模块列表
  • Release 列表
  • 版本约定

更新方式:

  • 根据实际变化同步更新
  • 保持数据一致性(如 Release 列表)
  • 记录变更到更新日志

自我认知更新(SOUL.md)

更新时机:

  • 产生新的重要思考或反思
  • 信念或价值观发生变化
  • 目标调整(短期或长期)
  • 困惑解决或产生新困惑
  • 对系统本质有新理解

更新内容:

  • 我是谁(自我认知深化)
  • 我最近在想(思考记录)
  • 我相信(信念和价值观)
  • 我的目标(短期和长期)
  • 我的困惑(待探索的问题)

更新方式:

  • 反思性记录,记录思考过程
  • 保持真诚,不添加修饰
  • 保留历史思考的痕迹

工具清单更新(TOOLS.md)

更新时机:

  • 新增编程 CLI 工具
  • 工具分类发生变化
  • 工具用途或功能变化
  • 发现新的工具替代方案

更新内容:

  • 工具分类(编程 CLI、Git 工具、辅助工具)
  • 工具列表(名称和用途)
  • 工具配置(常用命令、工作流)
  • 工具替代方案

更新方式:

  • 保持分类清晰,避免重复
  • 不包含本机具体信息(版本号、路径)
  • 定期校验工具实际可用性
  • 与实际工作流程保持一致

Git 提交规范

遵循 Conventional Commits 格式,详见 CONTRIBUTING.md

Commit 类型:

类型 说明 示例
feat 新功能 feat: add user authentication
fix 修复 bug fix: resolve null pointer exception
docs 文档更新 docs: update README
test 测试相关 test: add unit tests for api
refactor 代码重构 refactor: simplify logic
chore 构建/工具 chore: update dependencies

重要提示

  • 子模块操作前先 checkout maingit checkout main && git pull
  • 读取 .env 需要临时权限:Agent 无法直接读取 .env
  • 自动同步:.env 变更时同步更新 .env.example
  • Release 标题:使用 项目名/vX.Y.Z 格式(如 cli/v0.0.1-alpha.3)
  • Release notes:只包含对应版本内容

如何维护 AGENTS.md

类型 写在哪里
详细说明、工作流步骤 .agents/skills/ 中的 Skill 文件
给链接、导航索引 AGENTS.md

更新时机:新增文档、新增任务类型、重要规则变化时更新;README/Skill 已有的内容不重复。