SuperAPI AI 工具集

prepare

部署与运维

查看项目

更新于 10-15 10:24

技能介绍

用途

git-repo-prep:prepare 用于在代码库首次公开发布或开源之前进行系统性准备。它覆盖从审计到文档、加固与最终审查的完整生命周期,帮助用户把仓库调整到适合公开的状态。

主要能力

该技能将准备工作拆分为九个阶段:

  1. 发现:检测项目生态(Node.js、Python、Rust、Go、.NET、Ruby、Java/Kotlin 等),扫描项目结构,报告 README、LICENSE、.gitignore、CI/CD 配置、测试目录、CONTRIBUTING.md、SECURITY.md、CHANGELOG 等文件的存在情况。
  2. 密钥与个人信息审计:分别扫描硬编码的 API 密钥、密码、令牌、连接字符串、.env 文件、私钥等密钥信息,以及包元数据、源码注释、配置中的邮箱、真实姓名、用户名等个人信息。发现后警告 git 历史同样包含这些值,建议轮换/撤销真实凭据,并建议使用 git filter-repo 或 BFG Repo Cleaner 重写历史。
  3. 许可证:询问用户选择 MIT、Apache-2.0、GPL-3.0 或其他许可证,创建或更新 LICENSE 文件,更新包元数据中的 license 字段,在 README 中添加许可证章节,并检查 LICENSE 文件、包元数据与 README 之间的一致性。
  4. 文档:检查 README 是否包含项目用途、安装/入门、使用示例、配置、许可证、限制/已知问题等章节;提议 CONTRIBUTING.md 内容(报告 bug、提交变更、代码风格、测试期望、CLA/DCO 要求);提议 SECURITY.md 漏洞报告流程;可选建议 CLAUDE.md。
  5. gitignore 完善:按生态检查 .gitignore 是否符合最佳实践,确保 .env 与 .env.*、凭据目录、构建产物、IDE/OS 文件被排除;若敏感文件已被跟踪,标记并提议 git rm --cached 命令。
  6. 项目加固:先询问用户想要的加固级别(最小、标准、完整),再提议 CI/CD 工作流(运行测试、linter、在 push 和 PR 时触发)、依赖管理(Dependabot 或 Renovate)、pre-commit 钩子、覆盖率强制。
  7. 仓库元数据:按生态检查有助于可发现性和分发的元数据,如 Node.js 的 repository URL、engines、files、keywords、description;Python 的 [project.urls]、classifiers、requires-python;Rust 的 repository、keywords、categories、rust-version;Go 的模块路径与 godoc 注释。
  8. 待办与诚实披露:建议创建 BACKLOG.md 记录已知缺口、未完成功能或计划工作;建议在 README 中添加限制章节,说明已知限制、不支持的用例或稳定性注意事项。
  9. 最终审查:调用 git-repo-prep:review 作为最终验证,捕捉准备阶段遗漏的内容,并给出仓库开放状态的清晰总结。

使用方式

每个阶段遵循固定循环:标记该阶段任务为进行中;扫描/审计当前状态;向用户呈现发现;提出具体修改;通过 AskUserQuestion 询问跳过/批准/修改;实施已批准的修改;提交描述性信息(如 docs: add CONTRIBUTING.md);标记阶段任务完成并进入下一阶段。

适用场景

适用于准备将代码库首次公开发布或开源的个人或团队,尤其是需要系统化审计密钥与个人信息、补齐许可证与文档、完善 gitignore、配置 CI/CD 与依赖管理、补充仓库元数据、披露项目限制并做最终审查的场景。

限制

该技能明确要求不替用户做选择(许可证、CI 提供商、测试框架等均需询问);不偏离到代码质量审查(忽略代码风格、错误处理、架构、性能);不过度工程化(不添加 dotenv、验证、启动检查或超出用户要求的错误处理);不一次性倾倒所有内容,需逐阶段等待用户批准。它把个人信息视为与密钥不同的独立关注点。该技能不添加测试框架,因为那超出开源准备范围。