用途:指导把一个项目准备成可公开的 GitHub 开源发布版本,输入为 GitHub 用户名与项目根目录。
主要能力:先做代码完整性与功能核验,检查各模块能否协同工作、找出断裂流程或未使用模块,并说明功能交互、限制与预期运行行为;随后处理许可证,若已有 LICENSE 则添加标准头部(项目名与一行描述、版权声明、GPL v3 样板声明与分隔线),若缺失则用 curl https://www.gnu.org/licenses/gpl-3.0.txt 下载 GPL v3 文本并前置该头部。
用户名标准化:在 README.md、CONTRIBUTING.md、配置文件、脚本与注释中,将 YOUR_USERNAME、your-username、YOUR-USERNAME、<username> 等占位符替换为目标用户名。
文档套件:生成 CODE_DOCUMENTATION.md(目录结构、架构、核心模块表、数据流图、依赖、执行流程)、DESIGN_PHILOSOPHY.md(问题定义、方案理由、设计原则、目标受众与用例、权衡与约束)、CONTRIBUTING.md(缺陷报告格式、功能建议流程、Fork→Branch→PR 工作流、本地开发设置、提交前检查清单)、SECURITY.md 与 CODE_OF_CONDUCT.md,以及 .github 下的 bug_report.md、feature_request.md 与 pull_request_template.md。
收尾:确保 .gitignore 忽略密钥、日志与产物,核对文档路径,添加 GPL v3 徽章,统一命名与语气。
工具策略:使用 grep_search 查找占位符,replace_file_content 更新文件,run_command 配合 curl 获取许可证。
限制:资料未提供具体安装命令、收费信息、支持平台或效果保证;实际执行依赖相应工具环境,版权与用户名等元数据需按项目实际情况确认。