{"id":50962291,"url":"https://github.com/lavyoung/vibe-coding-starter","last_synced_at":"2026-06-18T15:33:27.739Z","repository":{"id":365646460,"uuid":"1273048866","full_name":"lavyoung/vibe-coding-starter","owner":"lavyoung","description":"一个面向人类 + AI 协同软件交付的文档优先 starter kit，内含 AGENTS、文档治理、状态闸门和可复用的 Codex skills。","archived":false,"fork":false,"pushed_at":"2026-06-18T09:20:23.000Z","size":81,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-18T09:23:20.005Z","etag":null,"topics":["ai","ai-collaboration","codex","docs-first","documentation","project-template","starter-kit","template","vibe-coding","workflow"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lavyoung.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":"docs/governance/ai-collaboration-best-practices.md","roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-06-18T06:55:57.000Z","updated_at":"2026-06-18T09:20:28.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/lavyoung/vibe-coding-starter","commit_stats":null,"previous_names":["lavyoung/vibe-coding-starter"],"tags_count":1,"template":true,"template_full_name":null,"purl":"pkg:github/lavyoung/vibe-coding-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lavyoung%2Fvibe-coding-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lavyoung%2Fvibe-coding-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lavyoung%2Fvibe-coding-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lavyoung%2Fvibe-coding-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lavyoung","download_url":"https://codeload.github.com/lavyoung/vibe-coding-starter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lavyoung%2Fvibe-coding-starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34497366,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-18T02:00:06.871Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","ai-collaboration","codex","docs-first","documentation","project-template","starter-kit","template","vibe-coding","workflow"],"created_at":"2026-06-18T15:33:25.956Z","updated_at":"2026-06-18T15:33:27.725Z","avatar_url":"https://github.com/lavyoung.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vibe-coding-starter\n\n一个面向“人类 + AI 协同交付”的文档优先模板仓库，内含可直接生效的 `AGENTS.md`、文档治理骨架、状态闸门规则和可复用的 Codex skills。\n\n如果你是通过模板创建了一个新项目，请先把本文件标题、首段简介和仓库描述替换成你自己的项目信息；`vibe-coding-starter` 只是上游模板名。\n\n## 第一次使用就按这 5 步\n\n如果你想先快速试起来，不用先通读整个仓库，直接按这个顺序：\n\n1. 复制模板到新项目\n2. 运行 `python scripts/init_starter.py`\n3. 补 4 份核心文档\n4. 运行检查脚本\n5. 看一份完整需求演示\n\n对应入口按这条链路继续看：\n\n- 第 1 到 4 步： [QUICKSTART.md](QUICKSTART.md)\n- 第 5 步： [DEMO.md](DEMO.md)\n\n## 这套模板要解决什么问题\n\n很多 AI 协作项目最后都会卡在同几个地方：\n\n- 代码改得比共识快\n- 新会话恢复不了上下文\n- 设计草稿被直接当成实现依据\n- 代码改了，但文档没有同步\n\n这套模板不是某个具体业务模板，而是一套面向仓库协作的基础约束与目录骨架：\n\n- 文档先行\n- 代码后行\n- 只有有效文档才能落代码\n- 新成员和新会话可以只靠仓库内文档恢复上下文\n\n## 你会得到什么\n\n- `AGENTS.md`\n  新仓库创建后即可生效的项目级协作约束起始版\n- `AGENTS.template.md`\n  便于二次抽取或对照修改的模板副本\n- `docs/`\n  一套完整的文档优先目录骨架\n- `.doc-sync.json`\n  一份可直接定制的机器校验规则文件\n- `prompts/`\n  新会话、设计阶段、代码改动阶段、小功能点修改时可直接复用的提示词\n- `scripts/`\n  可在本地和 CI 复用的 `doc-sync` 校验脚本、模板初始化脚本和统一自检入口\n- `tools/skills/`\n  三个通用 Codex skill：\n  - `doc-driven-implementation`\n  - `post-change-check`\n  - `code-review`\n- `examples/`\n  两个可直接参考的示例项目\n\n## 核心原则\n\n1. 仓库是事实源，不是聊天记录。\n2. 新工作先从文档开始，而不是从猜测开始。\n3. `草案`、`评审中` 只能用于讨论，不能直接作为实现依据。\n4. 只有 `已接受`、`已生效`、`已落地` 的文档才能支撑正式实现。\n5. 代码改动结束前，必须补一轮文档同步检查。\n\n## 目录结构\n\n```text\nvibe-coding-starter/\n├── .github/workflows/\n├── .doc-sync.json\n├── AGENTS.md\n├── AGENTS.template.md\n├── docs/\n│   ├── index.md\n│   ├── onboarding.md\n│   ├── evolution/\n│   ├── governance/\n│   ├── architecture/\n│   ├── rfcs/\n│   ├── explanation/adr/\n│   ├── requirements/\n│   ├── design/\n│   ├── tasks/\n│   ├── upgrade/\n│   ├── api/\n│   ├── sql/\n│   └── ui/              (可选：有界面项目时启用)\n├── examples/\n├── prompts/\n├── scripts/\n└── tools/skills/\n```\n\n## 快速开始\n\n首页只保留第一次采用最短路径，详细操作统一看 [QUICKSTART.md](QUICKSTART.md)：\n\n1. 复制模板到新项目\n2. 运行 `python scripts/init_starter.py`\n3. 补 4 份核心文档\n4. 运行检查脚本\n5. 看 [DEMO.md](DEMO.md) 里的完整需求演示\n\n## 4 条标准会话提示词\n\n如果你希望按固定节奏和 AI 协作，可以直接顺序使用：\n\n1. [prompts/standard-01-understand-current-state.txt](prompts/standard-01-understand-current-state.txt)\n2. [prompts/standard-02-minimal-implementation.txt](prompts/standard-02-minimal-implementation.txt)\n3. [prompts/standard-03-findings-first-review.txt](prompts/standard-03-findings-first-review.txt)\n4. [prompts/standard-04-human-review-focus.txt](prompts/standard-04-human-review-focus.txt)\n\n对应的方法论说明见：\n\n- [docs/governance/ai-collaboration-best-practices.md](docs/governance/ai-collaboration-best-practices.md)\n\n## 5 分钟上手\n\n- [QUICKSTART.md](QUICKSTART.md)：第一次采用模板时的唯一详细入口\n\n## doc-sync 与 CI 校验\n\n- [.doc-sync.json](.doc-sync.json)：维护机器可校验的代码 -\u003e 文档映射规则\n- [scripts/doc_sync_check.py](scripts/doc_sync_check.py)：`doc-sync` 的 Python 主实现\n- [scripts/doc_sync_check.ps1](scripts/doc_sync_check.ps1)：Windows PowerShell 入口\n- [scripts/doc_sync_check.sh](scripts/doc_sync_check.sh)：macOS / Linux shell 入口\n- [.github/workflows/doc-sync.yml](.github/workflows/doc-sync.yml)：默认接入 PR 与 `main` 分支校验\n\n## 本地统一检查入口\n\n- [scripts/check_all.py](scripts/check_all.py)：统一检查的 Python 主实现\n- [scripts/check_all.ps1](scripts/check_all.ps1)：Windows PowerShell 入口\n- [scripts/check_all.sh](scripts/check_all.sh)：macOS / Linux shell 入口\n\n示例：\n\n```bash\npython scripts/check_all.py\nbash scripts/check_all.sh\n```\n\n```powershell\n./scripts/check_all.ps1\n```\n\n## 一次完整需求演示\n\n- [DEMO.md](DEMO.md)：完成初始化后的下一步入口\n- [examples/minimal-task-board/README.md](examples/minimal-task-board/README.md)\n- [examples/spring-boot-device-center/README.md](examples/spring-boot-device-center/README.md)\n\n## 内置 skills\n\n### `doc-driven-implementation`\n\n适用于以下场景：\n\n- 需要从仓库文档恢复上下文\n- 需要判断哪些文档是当前有效依据\n- 需要先验文档状态再决定能不能落代码\n\n详见 [tools/skills/doc-driven-implementation/SKILL.md](tools/skills/doc-driven-implementation/SKILL.md)。\n\n### `post-change-check`\n\n适用于以下场景：\n\n- 代码或文档改完后做最后一轮收口检查\n- 核对文档同步、状态闸门和验证步骤\n- 在结束当前回合前输出变更范围和残余风险\n\n详见 [tools/skills/post-change-check/SKILL.md](tools/skills/post-change-check/SKILL.md)。\n\n### `code-review`\n\n适用于以下场景：\n\n- 提交前做一轮 reviewer 视角冷审\n- 变更完成后再检查 bug、回归风险和测试缺口\n- 需要对照文档和实现检查是否失真\n\n详见 [tools/skills/code-review/SKILL.md](tools/skills/code-review/SKILL.md)。\n\n## 推荐工作流\n\n```text\n需求出现\n  ↓\n先落 requirements/\n  ↓\n需要方案设计时，补 design/ 或 RFC\n  ↓\n文档进入有效状态\n  ↓\n再从有效文档落代码\n  ↓\n同步 docs / api / sql / upgrade\n  ↓\n执行 post-change check\n```\n\n## 适合什么项目\n\n- 长期演进的后端系统\n- 内部平台\n- AI 参与度高的交付流程\n- 需要跨人、跨会话接力的项目\n- 希望把设计与实现上下文沉淀在仓库里的团队\n\n## 不适合什么项目\n\n- 一次性脚本\n- 临时试验仓库\n- 生命周期很短的小型玩具项目\n\n## 发布与复用\n\n如果你准备把它发布成 GitHub 模板仓库，请先看：\n\n- [CHANGELOG.md](CHANGELOG.md)\n- [UPGRADING.md](UPGRADING.md)\n- [PUBLISHING.md](PUBLISHING.md)\n- [EXPORTING.md](EXPORTING.md)\n- [CONTRIBUTING.md](CONTRIBUTING.md)\n- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)\n\n## 状态口径补充\n\n本模板默认使用以下状态：\n\n- `草案`：已创建，仍在补充\n- `评审中`：正在讨论，还未定稿\n- `已接受`：方案已拍板，可以作为实现依据\n- `已生效`：治理规则、目录说明、流程规范已正式启用\n- `已落地`：方案已实现并完成文档同步\n- `已废弃`：不再作为当前有效方案\n\n## 许可证\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flavyoung%2Fvibe-coding-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flavyoung%2Fvibe-coding-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flavyoung%2Fvibe-coding-starter/lists"}