协作里程碑
checkpoint-collaborative-work;Git PR 流程。
25 分钟
协作里程碑
checkpoint-collaborative-work 不考新语法,而考 能否与他人(或未来的你)协作:GitHub profile、仓库命名、README、截图、LICENSE、PR 习惯。它是把 fsm-crud、fsm-cli、fsm-frontend 等散落练习 整理成可展示作品集 的关卡,并与 github-actions-essentials 的 PR 检查文化衔接。
学习目标
- 对照 /roadmaps/full-stack checkpoint-collaborative-work,整理 GitHub 上 全部里程碑项目,每仓具备 README、截图、LICENSE
- 遵循仓库命名与文档规范,使他人
git clone后 10 分钟内可跑通主流程 - 说清协作流:branch → PR → review → merge,与 fullstack-roadmap Git 节点一致
路线图推荐规范
| 项 | 建议 |
|---|---|
| 仓库名 | 小写 + 连字符,如 todo-cli、weather-dashboard |
| README | 项目是什么、如何安装、如何运行、示例命令/截图 |
| LICENSE | choosealicense.com 选 MIT/Apache-2.0 等 |
| 截图 | 终端或浏览器真实界面,非占位图 |
| Profile | 置顶 2–3 个代表项目,bio 一句话定位 |
README 模板
# 项目名称
一句话描述。对应 CodeRoadMap 里程碑:fsm-xxx / checkpoint-xxx。
## 功能
- 功能点 1
- 功能点 2
## 本地运行
### 依赖
- Node 20 / Java 21 / PostgreSQL 16 …
### 步骤
1. clone
2. install
3. run
## 截图

## 许可证
MIT
与 CI 的协作
为至少一个仓库添加 github-actions-essentials 工作流:PR 上跑 npm test 或 mvn test。绿勾成为 协作信号——reviewer 敢 merge。Secrets 不进日志;fork PR 不泄露密钥。
跨里程碑仓库策略
- 一里程碑一仓库(清晰,适合 portfolio)
- monorepo(
apps/cli、apps/web、infra/ansible)——需在 README 说明子目录命令
无论哪种,在 README 底部链接 /roadmaps/full-stack 已勾选节点,方便招聘方对照能力。
与后端/前端专项的展示
- spring-boot-essentials 练习可合并为
api/模块 - react-essentials 练习作为 子包