gitlink-scaffold

一个社区健康文件体检与模板生成的 GitLink AI Agent Skill。检测仓库是否缺失开源社区推荐的文件（README、LICENSE、CONTRIBUTING、CODE_OF_CONDUCT、SECURITY、Issue/PR 模板、CHANGELOG），给出健康度评分，并为缺失文件一键生成可用的中文模板。

GitLink 智能化服务开源项目贡献赛 子赛题二（编写和丰富 GitLink Skills） 参赛作品。

作者：Ct201314

它解决什么

一个规范的开源项目需要一整套社区健康文件，但新建或快速迭代的仓库常常缺这少那。gitlink-scaffold 把”该有哪些文件、还缺哪些、缺的怎么补”自动化：

体检：扫描仓库，检测 8 类社区健康文件是否存在（会在根目录、.gitlink/、.github/、docs/ 多处查找）
评分：按权重算出 0-100 健康度分，标记缺失的关键文件（README/LICENSE）
生成：为缺失的 CONTRIBUTING、CODE_OF_CONDUCT、SECURITY、Issue/PR 模板、CHANGELOG 生成开箱即用的中文模板

安装

作为 Agent Skill

把 SKILL.md 与 scripts/ 放入 Agent 技能目录（Claude Code、Cursor、Kiro CLI 等），向 Agent 提出诉求即可触发，例如：

「帮我看看 Gitlink/gitlink-cli 还缺哪些社区健康文件，并生成模板」

直接运行脚本

# 体检
python scripts/scaffold.py --owner Gitlink --repo gitlink-cli

# 体检并生成缺失文件的模板
python scripts/scaffold.py --owner Gitlink --repo gitlink-cli --generate --output-dir out

目录结构

gitlink-scaffold/
├── SKILL.md
├── scripts/
│   ├── glapi.py              GitLink 公开 API 客户端（自包含）
│   └── scaffold.py           体检与模板生成脚本
├── examples/                 真实体检报告 + 生成的模板
├── tests/test_scaffold.py    单元测试（10 个用例）
├── requirements.txt
└── LICENSE

真实验证

在 Gitlink/gitlink-cli 上运行，体检得分 40/100（README、LICENSE 齐全，其余缺失），并成功生成 6 个模板文件，产物见 examples/。

单元测试：

python -m pytest tests/ -q   # 10 passed

设计要点

多目录查找：社区文件在不同项目里位置不同，工具会在根目录与 .gitlink/、.github/、docs/ 多处查找，避免误报缺失。
加权评分：README 与 LICENSE 权重最高且标记为关键文件，符合开源项目的实际重要性。
只读 + 本地生成：体检只读，模板只生成到本地；提交到仓库由用户确认后执行，不擅自写远程。

许可证

Mulan PSL v2，与 gitlink-cli 主仓库保持一致。