|
|
||
|---|---|---|
| examples | ||
| references | ||
| scripts | ||
| tests | ||
| .gitignore | ||
| LICENSE | ||
| README.md | ||
| SKILL.md | ||
| requirements.txt | ||
README.md
gitlink-onboard
新贡献者上手指南生成器 GitLink AI Agent Skill。为想参与项目的新人一站式生成完整上手指南:项目简介、技术栈、核心目录导航、社区文件检查、good-first-issue、核心贡献者联系与上手步骤。
GitLink 智能化服务开源项目贡献赛 子赛题二(编写和丰富 GitLink Skills) 参赛作品。作者:Ct201314
它解决什么
新人想参与一个陌生项目,常常不知道「这是什么、代码在哪、找谁问、从哪开始」。gitlink-onboard 一条命令生成完整上手指南:
- 项目是什么:简介 + 技术栈(从依赖文件自动识别)+ 社区指标
- 代码在哪:核心目录导航,带语义提示(cmd=命令入口、internal=内部包…)
- 社区文件:README/CONTRIBUTING/行为准则是否齐全
- 从哪开始:适合新手的 good-first-issue
- 找谁问:核心贡献者
- 怎么提 PR:标准 Fork → 改 → PR 步骤
与 gitlink-newcomer 的区别
newcomer 面向维护者「识别并标注新手 Issue」;onboard 面向新人「生成完整上手指南」,覆盖面更广。
安装与使用
python scripts/onboard.py --owner Gitlink --repo gitlink-cli
目录结构
gitlink-onboard/
├── SKILL.md
├── scripts/ glapi.py + onboard.py
├── references/ api-reference.md + guide-structure.md
├── examples/ 真实上手指南
├── tests/test_onboard.py(10 用例)
├── requirements.txt
└── LICENSE
真实验证
在 Gitlink/gitlink-cli 上运行,生成完整上手指南:识别技术栈 Go/Make,导航 cmd/internal/skills 等核心目录,列出 good-first-issue、核心贡献者与上手步骤。产物见 examples/。
python -m pytest tests/ -q # 10 passed
许可证
Mulan PSL v2,与 gitlink-cli 主仓库保持一致。