launch-shadcn-registry

中文版: SKILL.zh-CN.md

发布 shadcn registry

为自定义 shadcn/ui registry 准备目录提交内容，然后撰写适合各平台的帖子。

开始之前

确认用户想要完整发布还是仅选定目标。除非用户缩小范围，否则默认执行完整工作流。

收集或推断 registry 配置信息。在生成提交内容前，询问缺失的必填字段。使用 templates/registry-profile.example.json 作为结构模板，并根据 templates/registry-profile.schema.json 进行校验。

必填配置字段：

字段	用途
scope	Registry 作用域，例如 @ogimagecn
name	显示名称
homepage	公开项目或文档 URL
registryBaseUrl	JSON 文件的基础 URL，末尾不带斜杠
componentUrlPattern	带有 {name} 占位符的 URL 模式，例如 https://example.com/r/{name}.json
description	一句话的目录描述，不超过 160 个字符
descriptionLong	用于 awesome 列表和社交帖子的两到三句话
githubUrl	源码仓库
githubUsername	用于头像 URL 和文件名
distribution	open-source 或 premium
categories	用于 shadcntemplates 和 awesome 列表的标签
installExample	完整的安装命令，例如 npx shadcn@latest add @scope/component-name
logo	可选的内联 SVG 字符串；建议为官方目录提供
registryIndexPath	可选的 registry 索引路径，相对于 registryBaseUrl；默认为 /registry.json
sampleComponents	可选的组件 slug，用于在预检期间验证，例如 ["og-image"]
features	用于 shadcntemplates 和社交帖子的可选要点
mcpUrl	可选的 registry 域名上的 MCP 端点，例如 https://example.com/mcp；awesome-ai-devtools 必需
freeTier	可选的免费套餐说明，包含具体限制；free-for-dev 必需
pricingUrl	可选的公开定价页面 URL；free-for-dev 必需

工作流

复制此清单并跟踪进度：

Launch Progress:
- [ ] Phase 1: Preflight validation
- [ ] Phase 2: Generate directory artifacts
- [ ] Phase 3: Open GitHub pull requests after user approval
- [ ] Phase 4: Draft social posts
- [ ] Phase 5: Post-launch follow-up

阶段 1：预检

阅读 references/preflight.md，在生成任何 PR 之前运行验证。

bash scripts/validate-registry.sh <registryBaseUrl> [sample-component-name]

在继续之前修复所有阻塞问题。常见失败：

• registry.json 未公开或路径错误
• 组件 JSON 返回 404
• 官方目录中存在重复的 @scope
• description 过长或过于营销化，不适合官方列表

获取官方目录以检查重复：

curl -fsSL https://raw.githubusercontent.com/shadcn-ui/ui/main/apps/v4/registry/directory.json | grep -i "<scope>"

阶段 2：生成产物

根据 registry 配置生成请求的提交文件。仅阅读这些目标对应的参考文档。

目标	参考	输出
官方 shadcn-ui/ui	references/shadcn-ui-official.md	JSON 条目 + PR 正文
registry.directory	references/registry-directory.md	JSON 条目 + PR 正文
shadcntemplates	references/shadcntemplates.md	content/{author}-{name}.md
birobirobiro awesome	references/awesome-birobirobiro.md	README 表格行
bytefer awesome	references/awesome-bytefer.md	README 表格行
free-for-dev	references/free-for-dev.md	README 列表项，需有托管的 SaaS 免费套餐
awesome-ai-devtools	references/awesome-ai-devtools.md	README 列表项，仅限带有域名派生 mcpUrl 的 MCP 服务

按仓库分组展示产物。包括：

1. 要创建或编辑的确切文件路径
2. 要添加的完整内容，而非部分 diff
3. 建议的 PR 标题和正文

PR 标题约定

对于官方 shadcn-ui/ui，请使用 feat(registry): add <scope>。这与 PR #10896 一致。对于 awesome 列表，请使用 docs: add <name> to <section>；对于 registry.directory，请使用 feat: add <name> registry。

阶段 3：发起 GitHub pull request

使用 gh 执行 GitHub 操作。除非用户已要求全部发起，否则在创建每个 pull request 前都要询问。

各仓库的标准 fork-and-PR 流程：

# Example: official shadcn-ui/ui
gh repo fork shadcn-ui/ui --clone=false
git clone https://github.com/<user>/ui.git /tmp/ui-registry-pr
cd /tmp/ui-registry-pr
git remote add upstream https://github.com/shadcn-ui/ui.git
git fetch upstream && git checkout -b feat/<scope>-directory upstream/main
# append the entry to apps/v4/registry/directory.json
git add apps/v4/registry/directory.json
git commit -m "feat(registry): add <scope>"
git push -u origin HEAD
gh pr create --repo shadcn-ui/ui --title "feat(registry): add <scope>" --body "$(cat <<'EOF'
## Summary
Adds <scope> to the community registry directory.

- Registry URL: `<componentUrlPattern>`
- Homepage: <homepage>
- Description: <description>

## Test plan
- [ ] `curl <registryBaseUrl>/registry.json` returns valid JSON
- [ ] `npx shadcn@latest add <installExample>` installs successfully
EOF
)"

除非用户另有选择，否则按以下顺序发起 pull request：

1. 官方 shadcn-ui/ui，曝光度最高的列表，也最可能需要维护者审核
2. rbadillap/registry.directory
3. shadcnblocks/shadcntemplates
4. birobirobiro/awesome-shadcn-ui 和 bytefer/awesome-shadcn-ui，这两项可并行进行
5. jamesmurdza/awesome-ai-devtools，仅当 registry 在自己的域名上部署了经验证的 MCP 服务时
6. ripienaar/free-for-dev，仅当 registry 域名提供 SaaS 免费套餐时；审核最慢，最后提交

在发布检查清单中记录 pull request URL。在 registry 上线且至少一个目录提交已发起或合并之前，不要将其描述为已发布。

阶段 4：起草社交帖子

阅读各平台参考文档，产出可直接粘贴的草稿。由用户手动发布。

平台	参考文档
Reddit r/shadcn	references/social/reddit.md
X	references/social/x.md
Dev.to	references/social/devto.md
Hacker News	references/social/hackernews.md

根据 registry 配置文件为每份草稿量身定制。包含安装命令、主页和 GitHub 链接。避免夸大宣传；以 registry 解决的具体问题开篇。

在预检通过后起草社交帖子。建议在官方目录 pull request 合并后再发布。至少等到 registry.json 上线。

阶段 5：跟进

在 PR 发起或合并后：

1. 分享仓库、pull request URL 以及每个提交的状态
2. 提醒用户在 48 小时内回复审核意见
3. 官方合并后，更新社交草稿，说明该 registry 现已列入 shadcn registry 目录
4. 如果 pull request 被拒绝，请阅读维护者的反馈，并在重新提交前修改描述或 registry 格式

规则

上述阶段未涵盖的护栏：

• 将官方 directory.json 条目追加到数组末尾。
• 每次提交都使用同一个 registry 配置文件。未经用户批准，不要编造相互冲突的描述。
• 对于 shadcntemplates 上的付费 registry，请说明首次上架免费，后续上架每次 100 美元。不要承诺一定通过审核。
• 当 registry 没有 MCP 服务时跳过 awesome-ai-devtools，当它没有 SaaS 免费套餐时跳过 free-for-dev。要说明原因，而不是起草。
• 从 registry 域名（profile.mcpUrl， 默认为 {homepage}/mcp）推导 awesome-ai-devtools 链接，并在起草前验证该端点。

附加资源

• Registry 配置文件 schema：templates/registry-profile.schema.json
• 示例配置文件：templates/registry-profile.example.json
• 验证脚本：scripts/validate-registry.sh