关于 setup-agent-skills
setup-agent-skills 是一项提示词驱动的技能,用于配置工程技能依赖的仓库约定。它先检查仓库并与用户确认选项,再写入问题跟踪、分类标签和领域文档说明。
主要功能
- 01检查仓库配置与文档
- 02配置问题跟踪说明
- 03设置分类标签词汇
- 04记录领域文档规则
- 05写入前确认检查结果
适用场景
- 01为新仓库配置工程技能
- 02记录 GitHub、GitLab 或本地问题跟踪方式
- 03使技能指南符合仓库领域文档
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ nstaab1/ nathan-agent-skills --skill setup-agent-skills安装后在 Claude Code 中输入/setup-agent-skills确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
domain.mdissue-tracker-github.mdissue-tracker-gitlab.mdissue-tracker-local.mdtriage-labels.mdagents/openai.yaml详细介绍
设置 Agent Skills
搭建各仓库的配置,供工程技能使用:
- Issue 跟踪器:问题所在的位置(默认使用 GitHub;也原生支持本地 Markdown)
- 分类标签:用于五种规范分类角色的字符串
- 领域文档:
GLOSSARY.md和 ADR 的存放位置,以及读取这些文档的使用者规则
这是一项由提示词驱动的技能,并非确定性脚本。先进行探索,展示发现的内容,与用户确认后再写入。
流程
1. 探索
查看当前仓库,了解其初始状态。读取现有内容;不要想当然:
git remote -v和.git/config:这是 GitHub 仓库吗?具体是哪个?- 仓库根目录中的
AGENTS.md和CLAUDE.md:是否存在?其中是否已有## Agent skills小节? - 仓库根目录中的
GLOSSARY.md和GLOSSARY-MAP.md docs/adr/和所有src/*/docs/adr/目录docs/agents/:此技能之前的输出是否已经存在?.scratch/:表明已在使用本地 Markdown 问题跟踪约定- 是否已安装
triage技能?(本技能旁边是否有triage技能文件夹,或可用技能中是否有triage。)这决定了是否运行 B 部分。 - Monorepo 信号:
pnpm-workspace.yaml、package.json中的workspaces字段,或包含自身src/的非空packages/*。只有真正大型的多包仓库才会具备这些信号;若不存在,则表示是单一上下文,这适用于几乎所有仓库。
2. 呈现发现并提问
总结已存在和缺失的内容。然后按顺序处理各个部分:一个部分给出一个回答,再进入下一个部分。
每个部分都以推荐答案开头,让用户只需一个词即可确认。仅当选择确实存在分支时,才给出一行说明。若探索阶段已经确定答案,则直接跳过该部分(当 triage 未安装时跳过 B 部分,当没有 monorepo 时跳过 C 部分)。
A 部分:Issue 追踪器。
说明:“Issue 追踪器”是本仓库 issue 的存放位置。
to-tickets、triage和to-spec等技能会读写它。它们需要知道应调用gh issue create,还是在.scratch/下写入 markdown 文件,或遵循你描述的其他工作流。请选择你实际用于追踪本仓库工作的地方。
默认立场:这些技能是为 GitHub 设计的。如果 git remote 指向 GitHub,则推荐 GitHub。如果 git remote 指向 GitLab(gitlab.com 或可自托管的主机),则推荐 GitLab。否则(或用户有偏好时),提供以下选项:
- GitHub:issue 存放在仓库的 GitHub Issues 中(使用
gh命令行工具) - GitLab:issue 存放在仓库的 GitLab Issues 中(使用
glab命令行工具) - 本地 Markdown:issue 以文件形式存放在本仓库的
.scratch/<feature>/下(适合个人项目或没有远程仓库的仓库) - 其他(Jira、Linear 等):请用户用一段话描述工作流;技能会将其记录为自由文本
将选择记录到 docs/agents/issue-tracker.md。GitHub 和 GitLab 模板带有一个“将 PR 作为需求入口”标记,默认关闭。保持关闭且不要主动提及:想让外部 PR 进入分诊队列的用户,可以之后在文件中修改该标记。
B 部分:分诊标签词表。 若 triage 技能未安装(探索阶段已得知),则完全跳过本部分,因为未安装的技能不需要标签。
若已安装,只问一个问题:
是否保留默认的分诊标签?(推荐:是)
默认值为五个标准角色,每个标签字符串与其名称相同:needs-triage、needs-info、ready-for-agent、ready-for-human、wontfix。选择“是”时,原样写入。只有用户选择“否”(通常是因为其 issue 追踪器已使用其他名称,例如用 bug:triage 代替 needs-triage)时,才收集覆盖配置,以便 triage 应用已有标签而不是创建重复标签。
C 部分:领域文档。 默认采用单上下文(仓库根目录下一个 GLOSSARY.md 加 docs/adr/)。这适用于几乎所有仓库,直接写入,无需询问。
仅当探索发现 monorepo 信号时,才提供多上下文选项(根目录的 GLOSSARY-MAP.md 指向各上下文的 GLOSSARY.md 文件),然后确认用户想要哪种布局。
3. 确认与编辑
向用户展示以下内容的草稿:
- 要添加到
CLAUDE.md/AGENTS.md中正在编辑的那个文件的## Agent skills块(选择规则见第 4 步) docs/agents/issue-tracker.md、docs/agents/domain.md和docs/agents/triage-labels.md的内容(最后一个仅在安装了triage时)
在写入前,让用户进行编辑。
4. 编写
选择要编辑的文件:
- 如果存在
CLAUDE.md,则编辑该文件。 - 否则,如果存在
AGENTS.md,则编辑该文件。 - 如果两者都不存在,请询问用户要创建哪个文件;不要替用户选择。
如果 CLAUDE.md 已存在,绝不要创建 AGENTS.md(反之亦然);始终编辑已存在的文件。
如果所选文件中已有 ## Agent skills 区块,请就地更新其内容,而不是追加重复区块。不要覆盖周围章节中的用户修改。
该区块:
## Agent skills
### Issue tracker
[one-line summary of where issues are tracked]. See `docs/agents/issue-tracker.md`.
### Triage labels
[one-line summary of the label vocabulary]. See `docs/agents/triage-labels.md`.
### Domain docs
[one-line summary of layout: "single-context" or "multi-context"]. See `docs/agents/domain.md`.
仅当 triage 已安装且已运行 Section B 时,才包含 ### Triage labels 子区块,并编写 docs/agents/triage-labels.md。否则,两者都省略。
然后,以此技能文件夹中的种子模板为起点,编写文档文件:
- issue-tracker-github.md:GitHub 问题跟踪工具
- issue-tracker-gitlab.md:GitLab 问题跟踪工具
- issue-tracker-local.md:本地 Markdown 问题跟踪工具
- triage-labels.md:标签映射(仅当
triage已安装时) - domain.md:领域文档使用者规则与布局
对于“其他”问题跟踪工具,请根据用户的描述从头编写 docs/agents/issue-tracker.md。
5. 完成
告知用户设置已完成,并说明哪些工程技能今后会读取这些文件。提及用户之后可以直接编辑 docs/agents/*.md;只有在想切换问题跟踪工具或从头开始时,才需要重新运行此技能。