Repo
快速初始化项目并自动生成贡献指南
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:Repo。 它的用途是:快速初始化项目并自动生成贡献指南 完整的 Skill 内容见:https://321skill.com/skills/repo-x-3/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'初始化我的项目并生成 CONTRIBUTING.md',它会扫描项目根目录下的所有文件,自动识别出项目使用 Node.js 和 TypeScript,然后生成包含项目简介、安装命令、分支命名规范、PR 提交步骤、Issue 模板指引的 CONTRIBUTING.md 文件,并提示你填写维护者邮箱和许可证信息。
介绍
项目初始化时,手动编写 CONTRIBUTING.md 贡献指南既繁琐又容易遗漏,尤其是开源项目需要明确代码规范、提交流程和沟通方式。本工具通过分析项目结构(如目录层级、语言类型、构建工具等),自动生成一份结构清晰、符合社区惯例的 CONTRIBUTING.md 文件,涵盖项目描述、安装步骤、分支策略、PR 规范、Issue 模板指引等内容。
使用非常简单:在项目根目录运行一条命令,工具会扫描所有文件、识别主流框架和工具链,然后生成包含占位符的文档,你只需根据实际项目补全具体细节(如维护者邮箱、行为准则链接等)。支持自定义模板和部分配置项,但默认输出已足够直接使用。
适合项目维护者、开源贡献者、技术负责人以及需要快速搭建规范贡献流程的团队。尤其适合新开项目或从零开始建立开源仓库的场景,能让贡献者第一时间了解项目规则,降低协作门槛。
建议在项目创建初期或迁移到新仓库时使用,生成后根据团队特殊要求(如特定 CI 流程、代码审查流程)微调即可。注意:如果项目已有复杂的贡献流程(如多模块独立贡献指南),本工具默认模板可能无法覆盖所有细节,需要手动合并或扩展。
核心特点
不同于通用的项目脚手架工具,本 Skill 专注于 CONTRIBUTING.md 的自动生成,能根据项目实际结构提取关键信息(如语言、构建工具、测试框架),并直接输出标准格式的贡献指南,无需手动搜索模板或逐项填写。
注意事项
不适合已有复杂自定义贡献流程(如多级审批、多仓库协作)的项目,默认模板可能无法覆盖所有特殊规则,需要手动调整。
常见问题
如何自定义生成的模板?
在项目根目录创建 .repo-config 文件或使用 --template 参数指定自定义模板路径,支持 Mustache/Handlebars 语法。具体可查看项目文档。
支持哪些项目结构识别?
支持常见编程语言(JS/TS/Python/Go/Rust 等)和构建工具(npm/yarn/pip/cargo 等),通过分析 package.json、pyproject.toml 等文件自动识别。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/repo-x-3/raw/index.md 读取 Repo 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/repo-x-3/raw/index.md(查看排版版本)