用途:repo-pitch 用于撰写或修正仓库对外展示的单行描述,覆盖 GitHub About 框、README 开头句、PyPI 或 npm 包摘要等场景。其核心观点是:仓库短描述应是一条字符串、多个投放目标,而非各写各的。
主要能力:脚本 scripts/pitch.py 内置全部阈值与规则,仅用标准库,可按路径运行。check 检查一条描述是否合规,--explain 解释各等级含义及无法检测的内容,surfaces 列出各平台长度预算及来源,readme 提取 README 中的短描述,drift 对比 README、GitHub 描述与 PyPI/npm 摘要是否一致。check 在阻断性发现时退出码为 1,drift 在各表面不一致时退出码为 1,均可用于门禁;所有命令支持 --json。
规则分级:规则分 block 与 warn。阻断规则包括以“<Name> is a…”开头、含 URL、含 emoji、含最高级形容词、超过 100 字符、第一人称、以冠词开头;警告规则包括超过 80 字符、重复自身名称、含两个及以上逗号。分级依据是规则在 856 个开发者工具仓库与 85,842 条 Debian 包摘要中的触发率,后者作为误报率参考。
风格选项:尾随句点和首字母大写两条规则无统一答案,默认关闭,可用 --style trailing-period=required、--style leading-capital=forbidden 显式指定。
用法示例: python3 <path>/pitch.py check "<the pitch>" --name <project> --surface github python3 <path>/pitch.py check "<the pitch>" --explain python3 <path>/pitch.py surfaces python3 <path>/pitch.py readme README.md python3 <path>/pitch.py drift --readme README.md --repo <owner>/<name> --pypi <package>
限制:该技能不写入任何内容,所有命令只打印,不编辑 README、不设置描述、不调用写 API;修正需用户自行编辑或执行 gh repo edit。仅 drift 需要联网(通过 gh 访问 api.github.com,以及 pypi.org 或 registry.npmjs.org),其余命令离线。它不评估质量,违规与 star 数相关性约 +0.056,不能声称“更好的简介能获得更多 star”。是否选对类别名词、声明是否真实、对非作者是否可读、是否借类比贬低竞品,均需人工判断。生成文本不应直接发往 Hacker News、awesome-readme、dev.to 等明确禁止 AI 生成或 AI 编辑内容的社区场景。