Skip to content

joeseesun/qiaomu-github-publisher

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

qiaomu-github-publisher

把一个能跑的项目,包装成 GitHub 上别人愿意点开、试用、安装、star 的开源项目。 Turn a working project into a GitHub-ready public release with a Chinese-first bilingual README, GitHub showcase surfaces, community health checks, verification, PR, and merge flow.

Install Skill GitHub License: MIT

为什么需要它

很多项目已经能跑,但 GitHub 首屏仍然像内部备忘录:README 没有痛点、没有截图、没有清晰安装路径,About 也没有抓住关键词。qiaomu-github-publisher 专门处理最后这一步:把项目变成一个陌生人也能理解、信任并愿意尝试的公开仓库。

它会帮你做什么

  • 重写或修补默认 README.md,让它成为中文优先、中英双语的产品页,而不是开发日志
  • 优化 README 的内容编排:真实截图/演示、三句价值叙事、可验证证明、功能矩阵、最快路径、折叠式手动安装、产品巡游、兼容矩阵、生态目录、工作流、结构和边界
  • 写中英双语 GitHub About 描述,设置 homepage 和 focused topics
  • 检查首屏是否能让陌生人在 60 秒内理解:价值、受众、行动、证据、信任
  • 检查截图、徽章、安装步骤、API 示例、Troubleshooting 和 social preview
  • 按项目姿态补齐或说明 license、SECURITY、CONTRIBUTING、CODE_OF_CONDUCT、issue/PR templates
  • 跑项目对应的 lint/build/test/install 验证
  • 扫描 diff 中的敏感信息
  • 创建 PR,并在验证通过后合并到 main
  • 对 Qiaomu-owned 项目默认加入向阳乔木 profile、链接和支持入口

Install

npx skills add joeseesun/qiaomu-github-publisher

Usage

安装后你可以这样说:

  • 把这个项目整理成适合 GitHub 发布的 README,并设置 About
  • 这个 repo 要开源,帮我包装一下再发到 GitHub
  • 重写 README,中文优先中英双语,验证后自动合并 main
  • 优化 GitHub topics、homepage 和项目描述

Workflow

  1. Inspect repo state and existing metadata.
  2. Rewrite the default README.md with a Chinese-first bilingual structure by default.
  3. Apply the first-viewport stranger test: value, audience, action, proof, trust.
  4. Shape the README as a scan-friendly product page: proof before internals, fastest path before manual setup, workflow and structure after quick start.
  5. For complex products, add product tour, compatibility matrix, ecosystem catalogs, architecture/security, roadmap/community, and provenance sections when relevant.
  6. Update GitHub About, homepage, topics, badges, social-preview guidance, and community-health posture.
  7. Run project-specific verification.
  8. Create a PR and merge verified changes into main unless explicitly held.

README Language Gate

For Qiaomu-owned public repos, the GitHub default README.md must open with Chinese first and still serve English readers. A separate README.zh-CN.md can exist, but it is not a substitute for a Chinese-first default README.

Minimum expectation:

  • Chinese value proposition and main sections appear first.
  • English value proposition and install/try/limits path are visible through an English section or linked English README.
  • GitHub About is compact bilingual by default: 中文短描述 | English short description.
  • If the default README is English-only or English-first, fix it before release.

GitHub Showcase Gate

The skill now checks the whole repository presentation, not only the README:

  • About/homepage/topics are concrete, bilingual where appropriate, and discoverable.
  • README first viewport contains a real CTA and proof: screenshot, demo, sample output, CI, or verified command.
  • README uses a deliberate composition: real hero media or screenshot, short value story, proof strip, compact badges, feature table, fastest quick start, expandable advanced setup, usage, workflow, project structure, and visible limits.
  • Complex products get a map, not a maze: product tour, platform compatibility, ecosystem catalogs, architecture/security model, roadmap/community, and provenance/license boundaries when relevant.
  • License is present for open-source repos, or absence is treated as a blocker.
  • External-contributor projects get community-health files: SECURITY.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, issue templates, and PR template.
  • Social preview is set when possible, or a manual GitHub Settings follow-up is recorded.

English

qiaomu-github-publisher is an Agent Skill for GitHub release polish. It helps turn working projects into public repositories with a Chinese-first bilingual README, discoverable GitHub metadata, social-preview guidance, community-health checks, real verification, and a complete PR-to-main publishing flow.

关于向阳乔木

向阳乔木(乔向阳 / Joe)是一位实践型 AI 产品与内容创作者,长期把前沿 AI 变化转译成可复用的工作流、产品判断、AI 编程实践、AI 搜索实践和 GEO/AI 营销方法。

支持与关注

打赏支持 微信公众号
向阳乔木打赏二维码 向阳乔木推荐看公众号二维码
感谢支持乔木持续分享 AI 实践 扫码关注「向阳乔木推荐看」

License

MIT

About

把项目发布成中文优先双语 GitHub 展示仓库 | Publish repos with Chinese-first README, showcase surfaces, community health, verification, PR, and merge.

Topics

Resources

License

Stars

3 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors