ai-github

GitHub Repo 展示层管家 Claude Skill 一句"完善这个 repo 的展示" → README 重写 + 描述润色 + topics 加标三件套，让你的 GitHub 项目页像个能用的产品。v2 新增两个可选附加步:⓪ Bootstrap(全新目录一键 git init + 建 GitHub repo + push)/ ④ LICENSE 自动补全(README 提了 MIT 但 repo 没 LICENSE 文件就补上)。

它是什么

在 Claude Code 里随手说一句——

"把这个 repo 的展示按 ai-short-drama-skill 风格重写"

——技能自动执行三件套：

📝 README 重写（mirror 参考 repo 的结构 + 填本 repo 实际内容，含 badges / "它是什么"具象触发示例 / "为什么做它"对比表 / 安装两法 / 用法 / 流程图 / 文件结构 / 自定义 / 版本史 / 贡献 / 致谢 / License）
📋 GitHub 描述润色（30-100 字一句话，按公式 [受众] + [触发] → [输出 + 卖点] 写，替代「X Claude Code skill」式裸分类描述）
🏷️ Topic 加标 10-15 个（按 6 类分布：生态 / 受众 / 用途 / 数据源 / 技术 / 语言）
🆕 ⓪ Bootstrap（可选）:全新目录还没 git init / GitHub 上还没 repo 时,自动 git init -b main + gh repo create --source=. --push(默认 public、repo 名 = cwd basename、分支 = main)
🆕 ④ LICENSE 自动补全（可选）:README 提了 MIT/Apache-2.0/GPL 但 repo 根缺 LICENSE 文件时,写标准 license 文本(默认 MIT,年份 = 当年,holder = git config user.name;其他 license 需明示)
🔍 自动调研：抓参考 repo README 拆解结构，读本 repo SKILL.md/源码提取功能列表
✅ 一站式落地：commit + push README + gh repo edit 描述 + gh repo edit --add-topic 全跑完

不是"通用 git 工具"，是 GitHub 页面展示层管家——README/描述/topics 三件套，决定 repo 在 github.com 上能否被搜到 + 第一屏看不看得下去。

为什么做它

GitHub 上 Claude skill 类 repo 已不少，git 操作向 skill 也很多（commit / branch / PR / Actions / Pages）。但展示层全员摆烂：

通病	本 skill 改进
README 只一行"my Claude skill"	mirror 参考 repo 完整 17 段结构 + 填本 repo 内容
GitHub 描述写 "Claude Code skill"（10 字裸分类）	公式化 100 字描述（受众 + 触发 + 输出 + 卖点）
0 topic 或随手加 3 个	6 类分布 10-15 个 topic（生态/受众/用途/源/技术/语言）
README 复制 SKILL.md 当营销	README 是营销，SKILL.md 是说明书，定位分清
触发示例写"用户输入需求"	必须具象可输入——"今天有啥新的" √
"为什么做它"对比表 3 行凑数	强制 ≥ 8 行，少了砍掉换 bullet
版本史写"修了 bug"	每版列关键改进（加了什么字段、解决了什么 pain）
Badges 加 LinkedIn 风"Made with ❤️"	基础 3 个（Skill / License / PRs），按真实情况加 CI / coverage
Topic 撒盐 20 个	GitHub 只 surface 前 ~12，挑准比加多重要
改完 README 不 push / 改完描述不验证	自动 commit + push + `gh repo view` 验证
与现有 git skill 重叠	严格只做展示层，git 操作让位 `claude-skill-git` 等

底层赌注：SKILL.md 写得再好，repo 主页空荡，新用户 3 秒就关。展示层是 repo 流量入口，不是装饰。

安装

方法 1：克隆到 Claude Code 全局 skills 目录

# Windows PowerShell
git clone https://github.com/A-cat-with-carrots/ai-github-skill.git "$HOME\.claude\skills\ai-github"

# macOS / Linux
git clone https://github.com/A-cat-with-carrots/ai-github-skill.git ~/.claude/skills/ai-github

方法 2：作为项目本地 skill

cd <your-project>
mkdir -p .claude/skills
git clone https://github.com/A-cat-with-carrots/ai-github-skill.git .claude/skills/ai-github

重启 Claude Code（或新开会话），技能自动加载。

依赖

Claude Code with Read / Write / Edit / Bash 工具
gh CLI（已登录）：https://cli.github.com/
- 用于读参考 repo + 改 description + 加 topics
- gh auth login 登录后即可

用法

在 Claude Code 里说一句：

> 把这个 repo 的展示按 ai-short-drama-skill 风格重写

或任意触发词：

/ai-github
完善 / 润色 / 美化 [repo] 展示
把 README 改成 X 风格
加 / 完善 GitHub 标签 / topic
改 / 写个 GitHub 描述
polish 我的 GitHub / rebrand 这个 repo
GitHub 页面太空 / 看起来不像个项目

技能自动触发，按 6 步主流程 + 2 个可选附加步跑：

Step 0：Bootstrap（可选）─ cwd 非 git / GitHub 无 repo ─ git init + gh repo create + push
        │
Step 1：确认目标 repo + 参考风格 repo            ─┐
Step 2：抓两边内容（参考 README + 本 repo SKILL）  │
Step 3：起草新 README（17 段镜像结构）            ├─→ ~5 分钟
Step 4：起草 GitHub 描述（公式化 100 字）          │
Step 5：起草 Topics 列表（6 类 10-15 个）         │
Step 6：commit + push + gh repo edit + 验证      ─┘
        │
Step 7：LICENSE 补全（可选）─ README 提了 license 但缺 LICENSE 文件 ─ 写标准文本 + commit + push

预检测:启动前自动跑 git rev-parse --is-inside-work-tree / gh repo view / ls LICENSE,决定要不要进 ⓪/④。

附加步与三件套详解

⓪ Bootstrap — 建新 repo(可选)

触发条件(满足任一):

cwd 不在 git repo(git rev-parse --is-inside-work-tree 报错)
cwd 是 git repo 但无 origin remote
有 origin 但 gh repo view <owner>/<name> 返回 404

执行:

# 1. 检测三连
git rev-parse --is-inside-work-tree 2>&1
git remote get-url origin 2>&1
gh repo view <owner>/<name> 2>&1

# 2. git init(仅当不是 git repo)
git init -b main
git add -A
git commit -m "init: <repo-name> v1"

# 3. 建 GitHub repo + push 一步到位
gh repo create <repo-name> --public --source=. --remote=origin --push \
  --description "<占位描述,Step 4 会覆盖>"

默认值:repo-name = cwd basename · --public 默认 · branch = main。私有 / 自定义名需用户明示。

触发用户原话:"把这个推到 GitHub" / "推到我们的 GitHub 上" / "建个 repo + 三件套全做" / "新 skill 上 GitHub"。

三件套详解

① README 重写（17 段配方）

#	段名	核心内容
1	标题 + tagline	一行价值主张
2	Badges	Skill / License / PRs（基础 3 个）
3	它是什么	具象触发 → bullet 输出 → punchline
4	为什么做它	对比表 ≥ 8 行（最有说服力的段）
5	安装	两法（Windows + macOS/Linux）
6	用法	触发词 + ASCII 流程图
7-9	中段	数据源表 / 流程速览 / 输出模板（按形态选）
10	文件结构	tree 块
11	自定义	编号 4-6 项，每项给精确锚点
12	为什么是 skill 不是脚本	可选段
13	已知限制	4-6 条真实限制
14	版本历史	每版列关键改进
15	贡献	4-5 条重点方向（不是空泛 "PR welcome"）
16	致谢	上游 + 工具链
17	License	MIT 链接

详见 references/readme-style-guide.md。

② GitHub 描述（公式化）

长度：350 字符 GitHub 上限，中文约 100-150 字到顶。

公式：

[名称] [类别] — [触发短语] → [核心输出 + 卖点 1-3 个] + [产物形态]

例（pm-daily-brief 实战）：

前：

AI产品经理每日情报简报 Claude Code skill

后：

AI 产品经理每日情报简报 Claude Skill — 一句『今天有啥新的』 → 三源融合（PH/GH/HN）+ 用户画像加权 + TL;DR 60 秒摘要 + Top 3-5 深读 + 全列表 [跟进/关注/噪音] triage，中文 Markdown/PDF 双输出

详见 references/description-formula.md。

③ Topics 加标（6 类）

类	数量	例	必有？
生态	2-3	`claude-skill` `claude-code` `anthropic`	必
受众	1-2	`ai-product-manager` `developer` `creator`	推
用途/动作	2-3	`daily-brief` `code-review` `repo-management`	必
数据源	0-3	`producthunt` `github-trending` `hacker-news`	视情况
技术	1-2	`prompt-engineering` `llm` `markdown-to-pdf`	推
语言/区域	0-2	`chinese` `english`	视情况

总数 10-15——GitHub 只 surface 前 ~12 个，多了被截。

详见 references/topic-taxonomy.md。

④ LICENSE 补全(可选)

触发条件:README 提了 license(MIT / Apache-2.0 / GPL-3.0 等) 且 repo 根目录无 LICENSE / LICENSE.md / LICENSE.txt 文件。

执行:

# 1. 检测
ls LICENSE LICENSE.md LICENSE.txt 2>/dev/null

# 2. 取身份
year=$(date +%Y)
holder=$(git config user.name)   # 或问用户用 GitHub username

# 3. 写文件(MIT 模板见 SKILL.md Step 7)
# 4. 单独 commit + push
git add LICENSE
git commit -m "chore: add MIT LICENSE"
git push origin HEAD

铁律:

README 写 MIT,repo 必须有 LICENSE 文件 —— 否则 GitHub 侧栏不显示 license、社区工具(deps.dev / Snyk)误判为"无许可"=保留所有权利
默认 MIT;其他 license(Apache-2.0 / GPL / BSD / 商业)需用户明示
单独 commitchore: add LICENSE,不混进 README commit,历史更干净

与现有 git/github skill 协作

GitHub 上同主题 skill 已不少，严格分工：

任务	用哪个
commit message 生成	`Claude-Skill-Git-Commit-Message` / `claude-skill-git-commit-helper`
原子 commit / staging 策略	`faceleg/claude-skill-git`
分支/PR/Actions/repo 规范	`claude-skill-github-best-practices`
PR 内联评论	`claude-skill-github-pr-inline-comments`
部署 GitHub Pages	`claude-skill-github-pages-deployer`
Actions workflow	`claude-skill-github-actions`
重写 commit author	`claude-skill-git-author-update`
README + 描述 + topics 三件套	`ai-github`（本 skill）

本 skill 不做：commit / branch / PR / Actions / Pages 部署 / release / tag。这些用上面的专精 skill。

文件结构

ai-github/
├── SKILL.md                          # 主入口（6 步编排）
├── README.md                         # 本文件
├── LICENSE                           # MIT
├── references/
│   ├── readme-style-guide.md         # README 17 段配方 + 写作铁律 + 反模式
│   ├── description-formula.md        # 描述公式 + 实证对比
│   └── topic-taxonomy.md             # 6 类 topic 分类法 + 决策树
└── examples/                         # 实战案例（before/after）

自定义

1. 默认参考风格 repo

SKILL.md Step 1，没指定参考时默认列同 owner 已有 repo。改成你常用的 polished repo 当默认模板。

2. README 配方段数

references/readme-style-guide.md 列 17 段。轻量项目（< 1k 行）可砍到 12 段（去掉"为什么是 skill 不是脚本" / 自定义 / 输出模板）。

3. Topics 上限

默认 10-15。GitHub 硬上限 20。改 references/topic-taxonomy.md 的"决策树"末尾。

4. Commit 风格

默认 Conventional Commits（docs: ...）。如 repo 用其他风格（如 emoji-prefix），改 SKILL.md Step 6 的 commit 模板。

5. 语言默认

默认中文。英文社区项目改 SKILL.md Step 3-5 的"写作铁律"段 + reference 文件的示例语言。

已知限制

建新 repo 仅在用户明说时做——v2 起 Step 0 可跑,但默认假设 repo 已存在;说"推到 GitHub" / "新 skill 上 GitHub"才走 Bootstrap
不改源代码——只改 README + GitHub metadata + LICENSE
不替你写 SKILL.md——SKILL.md 用 skill-creator
gh CLI 必须已登录——未登录会卡在 Step 0 / Step 1
参考 repo 必须公开——私有 repo 抓不到 README
README 是镜像结构不是抄文字——若参考 repo 内容跟本 repo 差太远（如剧本 skill 镜像数据简报 skill），17 段会有些位空，需手动取舍
Topics 归一可能改名——AI_Skill 加进去会变 ai-skill，验证步骤会发现
LICENSE 默认 MIT,其他需明示——Apache-2.0 / GPL / BSD / 商业 license 必须用户主动选,避免误选

版本历史

v2(当前):加 ⓪ Bootstrap + ④ LICENSE 两个可选附加步
- Step 0 Bootstrap:cwd 非 git repo / GitHub 无 repo 时,自动 git init -b main + gh repo create --source=. --push,默认 public、repo 名 = cwd basename、分支 = main
- Step 7 LICENSE:README 提了 license 但缺 LICENSE 文件时,写标准文本(默认 MIT,年份 = 当年,holder = git config user.name),单独 commit chore: add LICENSE
- 启动指令加 3 个预检测(git rev-parse / gh repo view / ls LICENSE),决定要不要进 ⓪/④
- 触发词加"把这个 skill 推到 GitHub" / "推到我们 GitHub 上"
- 边界放宽:从"不创建新 repo / 不写 LICENSE" → "用户明说时做,LICENSE 默认 MIT 其他需明示"
v1:初版
- 17 段 README 配方
- 描述公式 [名称][类别]—[触发]→[输出+卖点]+[产物]
- 6 类 topic 分类法 + 决策树
- 6 步工作流（确认 → 抓内容 → 起草 README → 起草描述 → 起草 topics → 应用）
- 与 8 个现有 git/github skill 协作分工表

贡献

PR 欢迎。重点方向：

加更多参考风格（除了 ai-short-drama / pm-daily-brief，加英文社区典范如 anthropics/skills 风格）
加 description 多语言公式（英文 / 日文 / 韩文 repo 各自风格）
README 段配方分形态（数据 skill / 流程 skill / 工具 skill 模板差异化）
GitHub social preview 图自动生成（Open Graph image，目前未覆盖）
批量模式：用户 owner 下所有 repo 一键扫展示层完整度，给优先级清单

致谢

灵感来自实战：rebrand pm-daily-brief-skill 时发现"git 操作 skill 多，展示层 skill 无"的 GitHub 生态空白
参考风格 anchor：ai-short-drama-skill（自家 polished 模板）
skill 脚手架：Anthropic skill-creator
同主题 skill 调研：见与现有 git/github skill 协作一表

License

MIT — 见 LICENSE

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

ai-github

它是什么

为什么做它

安装

方法 1：克隆到 Claude Code 全局 skills 目录

方法 2：作为项目本地 skill

依赖

用法

附加步与三件套详解

⓪ Bootstrap — 建新 repo(可选)

三件套详解

① README 重写（17 段配方）

② GitHub 描述（公式化）

③ Topics 加标（6 类）

④ LICENSE 补全(可选)

与现有 git/github skill 协作

文件结构

自定义

1. 默认参考风格 repo

2. README 配方段数

3. Topics 上限

4. Commit 风格

5. 语言默认

已知限制

版本历史

贡献

致谢

License

About

Uh oh!

Releases

Packages

Uh oh!

Contributors

Uh oh!

Name		Name	Last commit message	Last commit date
Latest commit History 3 Commits
references		references
LICENSE		LICENSE
README.md		README.md
SKILL.md		SKILL.md

Folders and files

Latest commit

History

Repository files navigation

ai-github

它是什么

为什么做它

安装

方法 1：克隆到 Claude Code 全局 skills 目录

方法 2：作为项目本地 skill

依赖

用法

附加步与三件套详解

⓪ Bootstrap — 建新 repo(可选)

三件套详解

① README 重写（17 段配方）

② GitHub 描述（公式化）

③ Topics 加标（6 类）

④ LICENSE 补全(可选)

与现有 git/github skill 协作

文件结构

自定义

1. 默认参考风格 repo

2. README 配方段数

3. Topics 上限

4. Commit 风格

5. 语言默认

已知限制

版本历史

贡献

致谢

License

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Packages