开源与 GitHub

开源与 GitHub 是 DevRel 离开发者最近的工作台：Issue、PR、SDK、CLI、VS Code 插件都在此发生。维护好 Repo 等于维护产品的开发者界面。与 /roadmaps/devrel 开源与工具节点对齐。

学习目标

• 掌握 Issue / PR triage 与社区贡献者体验
• 理解 SDK、Sample App、Developer Tools 的分工
• 建立 README、CONTRIBUTING、模板的标准结构

核心概念

Repo 即产品

README — 5 秒懂是什么、3 分钟能跑起来
CONTRIBUTING — 如何提 Issue、PR 规范、Code of Conduct
Templates — Bug / Feature Issue、PR Checklist
Examples/ — 最小可运行示例，CI 保证不腐化

第一印象来自 README，不是官网 Landing Page。

Issue 与 PR triage

标签	用途
bug / enhancement / question	分类路由
good first issue	降低新人贡献门槛
priority / P0–P2	与工程对齐修复顺序
stale	长期无回复自动提醒

响应 首条回复 SLA（如 48h 内 acknowledge）比立刻修复更重要；沉默会流失贡献者。

SDK 与 Developer Tools

• SDK：封装认证、重试、类型；版本与 API 同步发布
• CLI：适合自动化与 CI 场景
• IDE 插件（如 VS Code）：补全、Snippet、本地调试
• Sample App：端到端演示，Issue 可复现时用同一 Repo

CodeRoadMap 若提供 Spring Boot Starter 示例，DevRel 需保证 与文档版本号一致，并在 Release Note 中标注。

安全与信任

• 不 merge 未审查的外部 PR 到敏感路径
• SECURITY.md 说明漏洞上报渠道
• 依赖扫描、License 合规纳入发布流程

练习

• 为虚构 SDK Repo 写 README 骨架（安装、Quickstart、链接）
• 设计 Issue 模板 3 字段（环境、复现步骤、预期行为）
• 列出 good first issue 的 3 个选题标准

小结

GitHub 是 DevRel 的主战场；Repo 整洁、响应及时，贡献才会增长。 下一课进入活动与 Webinar。