Agents Style

创建或修改 AGENTS.md 前必须读取并遵守本 skill。按 4 章骨架生成或精简仓库根级 AGENTS.md,只装长期有效的内容;只处理仓库根的单文件。即使没人让你动 AGENTS.md,只要本次工作新增或修改了约定、禁区、高频命令,也必须主动触发本 skill 检视是否需要同步更新。

caikiji 541daf2 2.2 KB Updated

File contents

AGENTS.md Skill

生成或精简仓库根级 AGENTS.md;只装 6 个月后仍正确的内容,过不了就砍,或改成指向("以 CI 为准")。

骨架(4 章)

# <项目名>

> 写一句话事实定位:项目用途 + 技术栈,不写营销话。

## 约定
- 写可裁决规则,≤10 条(对错可判断,如"用 X 不用 Y")

## 边界
- 列不能碰的文件/目录(生成物、vendor、CI 管理文件),每条一句话理由
- 写安全红线:密钥只写环境变量名;列需用户确认的操作

## 常用命令
- 列 ≤3 条最高频命令,精确可复制
- 其余写"以 CI / Makefile 为准"或指向源文件

## 深文档
- 列索引链接,不内联;没有就整章省略

装 / 不装

✅ 装 ❌ 不装
项目定位一句话 版本号、依赖清单、环境细节
可裁决的约定 愿景、营销、团队闲谈
边界与安全红线 一次性流程、发布步骤细节
≤3 条高频命令 bug 规避记录、历史背景
深文档索引 "保持整洁/优雅"类品味词、穷尽式清单

生成

  1. 扫描:package.json / pyproject.toml / Cargo.toml / go.modMakefile/justfile、CI 配置、README、目录结构、.gitignore
  2. 只问扫描不到且影响行为的,≤2 问(项目特有约定、需审批的操作)。语言跟随项目现状。
  3. 按骨架写出;每条过一遍筛选标准;命令只用扫描到的真实配置,禁止编造。

诊断(瘦身)

读现有 AGENTS.md,逐项处理:

  1. 删快速过期内容,或改为指向。
  2. 删废话:愿景、品味词、穷尽枚举。
  3. 精简命令到 ≤3 条高频,并核对与仓库现状一致。

输出:删除/修改清单(每项一句理由)+ 瘦身后的全文;收尾跑一遍最高频命令,确认真实可用。

caikiji/skills-lab/tree/main/skills/deprecated/agents-style commit 541daf203c

Frequently asked questions

npx skillmds@latest add caikiji/agents-style