关于 init
用于分析代码库并创建 AGENTS.md 的初始化技能,供后续 Droid 实例参考。它记录常用开发命令和跨文件架构信息;若文件已存在,会先展示建议内容并请求确认。
主要功能
- 01创建代码库专属 AGENTS.md
- 02记录构建、检查与测试命令
- 03概述高层架构
- 04纳入现有项目指引
- 05修改已有文件前请求确认
适用场景
- 01为后续 Droid 会话准备代码库
- 02记录单项测试的运行方式
- 03汇总 README 与 Agent 规则中的关键信息
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ factory-ai/ factory-plugins --skill init安装后在 Claude Code 中输入/init确认已加载。
详细介绍
请分析此代码库并创建一个 AGENTS.md 文件,供后续的 Droid 实例在此仓库中工作时使用。
需要添加的内容:
- 常用命令,例如如何构建、运行 lint 和测试。还要包括在此代码库中开发所需的命令,例如如何运行单个测试。
- 高层次的代码架构和结构,帮助后续实例更快上手。重点介绍需要阅读多个文件才能理解的「整体」架构。
使用说明:
- 分析代码库后,如果不存在 AGENTS.md,请直接创建。如果已存在 AGENTS.md,请展示拟议的新内容,并在修改文件前征求确认。
- 创建初始 AGENTS.md 时,不要重复内容,也不要写入显而易见的指示,例如「向用户提供有用的错误消息」「为所有新增实用程序编写单元测试」「切勿在代码或提交中包含敏感信息(API 密钥、令牌)」。
- 避免罗列可轻易查明的所有组件或文件结构。
- 不要加入通用的开发实践。
- 如果存在 Cursor 规则(位于 .cursor/rules/ 或 .cursorrules)、Copilot 规则(位于 .github/copilot-instructions.md)或 CLAUDE.md 文件,请确保纳入其中的重要内容。
- 如果存在 README.md,请确保纳入其中的重要内容。
- 除非你读取的其他文件中明确包含相关内容,否则不要编造「常见开发任务」「开发技巧」「支持与文档」等信息。
评论
支持 Markdown