Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 2.25 KB

File metadata and controls

53 lines (38 loc) · 2.25 KB

AGENTS.md - quanttide-platform

Skills provide specialized instructions and workflows for specific tasks. Use the skill tool to load a skill when a task matches its description.

SKILL 快速索引

Skill 用途
devops-commit 规范提交
devops-release 发布 Release
devops-review 流程审查
docs-deploy MyST 文档站构建与 GitHub Pages 部署

文档地图

文档 认知角色 内容概要
CONTRIBUTING.md 程序记忆 设计原则、版本策略、检查清单
README.md 陈述记忆 项目定位、仓库结构、产品清单
ROADMAP.md 方向 当前阶段目标、待办事项、优先级
CHANGELOG.md 记忆 版本变更历史、发布记录
docs/index.md 架构 仓库层级关系、边界文档索引

AI 执行指引

开始工作前,先阅读 CONTRIBUTING.md 的设计原则与项目约定。

过往经验表明 AI 最容易在这些地方犯错,请特别注意:

  • 替换 vs 并存:修改内容前先确认旧内容怎么处理,不要默认替换
  • 改内容 vs 改名字:操作前明确目标是文件/目录的内容还是名称
  • 子仓库 vs 主仓库:不要在子仓库里做主仓库的事(如改其 ROADMAP),也不要反过来
  • 减法优先:删除无效内容的优先级高于新增,宁可空着不放不确定的东西
  • 目录即语义:目录名使用代码实际结构,不用抽象概念,有实体才建目录

特殊文档提醒

完成重要变更后,检查是否需要同步更新以下文档:

文档 触发条件
CHANGELOG.md 对用户可见的变更(新功能、重构、修复)
ROADMAP.md 方向调整、阶段性成果达成
CONTRIBUTING.md 工作方式或原则发生变化
README.md 产品功能或仓库结构变化
AGENTS.md AI 工作经验增加

AI 应在完成工作后主动提醒用户是否需要更新这些文档,而非等用户提出。

子模块

各子模块有自己的 AGENTS.md,开发前查阅具体模块。