repo-polish

先读，再写

构建配置和锁文件给出技术栈与版本，任务运行器给出上手命令，CI 配置给出贡献者必须跑通的检查，提交历史给出这个项目实际在用的提交规范。查不到的事实留方括号占位符，不猜——一个编出来的安装命令比没有安装命令更糟，因为读者会照着跑。

七件事当成一件事

README、横幅、LICENSE、SECURITY.md、CONTRIBUTING.md、平台上的仓库简介、topics——它们回答的是同一个问题：这是什么、我能不能用、接下来去哪。

所以「这是什么」只定一次。README 的居中那行、平台上的仓库简介、包清单里的 description，用的是同一句话，而不是三种说法。这三处不一致是最常见的一种失修：README 说的是三次重写之前的事，而简介停在更早。

两条硬规矩

**许可证从不替你选。**它只把已有的声明理顺；发现 LICENSE 和 package.json 各说各话就停下来报给你，不按更宽松的那个下结论。

**写到托管平台的东西先给你看。**仓库简介和 topics 会离开本地、在 diff 里看不见，所以它把要写的值原样打印出来，等你点头再发。发不出去时它报告为「被阻塞」并附上命令，而不是说「已设置」。

它不做的事

它不写 API 参考文档、changelog、发版说明和营销落地页，也不改源代码本身。