qshenzhang/anta-workshopdemo

Public

WeChat Login

Code Issues Pull requests Events Packages Insights

main

Branch

Tag

Qisen

合并来自 feature/q3-m9-consumer-case 的合并请求 #47

8ae2db8a

120 commits

.codebuddy
docs
scripts
.cnb.yml
.env.example
.gitignore
CHECKPOINT.md
LESSONS.md
README.md

项目脚手架（`.codebuddy/` 框架模板）

这是一份开箱即用的团队工作框架，包含 rules / skills / governance 三层结构。本仓库本身是空脚手架——业务代码需要自己填，但所有规则、工作流、治理框架已经就位。

快速上手（4 步）

# 1. 克隆作为新项目起点
git clone <this-repo> my-new-project
cd my-new-project

# 2. 拷贝环境变量模板并填写
cp .env.example .env
# 编辑 .env 填入实际值

# 3. 按新项目技术栈调整规则
#    - project-architecture.md：更新技术栈声明表
#    - backend-core.md：通用骨架通常不用改；若要新增栈（Go/Python/Node），复制为 backend-<stack>.md
vim .codebuddy/rules/project-architecture.md

# 4. 用脚手架生成第一个模块，开始开发
# （按 .codebuddy/skills/scaffold/SKILL.md 的指引）

你是谁？该读什么？

你是	读这里
开发者 / Agent（想知道该怎么做）	`.codebuddy/README.md` → `rules/` + `skills/`
Leader / 项目负责人（想知道该怎么管）	`.codebuddy/governance/README.md`
想带走经验 / 迁移框架到新项目	`LESSONS.md`（结论）+ `CHECKPOINT.md`（本仓库轨迹，作为格式样板）
想知道团队踩过的坑	`.codebuddy/rules/.archived/feedback/README.md`

目录结构

├── .codebuddy/                     # 框架本体（rules + skills + governance）
│   ├── rules/                      # 规则（执行层强制约束）
│   │   ├── meta-principles.md      # R0 元原则（所有规则的根）
│   │   ├── backend-core.md         # 后端核心规范（技术栈无关）
│   │   ├── frontend-core.md        # 前端核心规范（技术栈无关）
│   │   ├── testing-standards.md
│   │   ├── ...
│   │   └── .archived/
│   │       ├── backend-java-spring.md  # 后端规范 · Java + Spring Boot 参考实现
│   │       ├── frontend-vue.md         # 前端规范 · Vue 3 + TypeScript 参考实现
│   │       └── feedback/           # FB 归档事实源（空索引表等待填入）
│   ├── skills/                     # 9 个 skills（可复用工作流模板）
│   │   ├── requirement-workflow/
│   │   ├── scaffold/
│   │   ├── cicd-pipeline/
│   │   ├── code-review/
│   │   └── ...
│   ├── governance/                 # 5 份治理文档（Leader 视角）
│   │   ├── delivery-lifecycle.md   # 流程契约
│   │   ├── quality-dashboard.md    # 质量仪表盘
│   │   ├── retrospective-sop.md    # 复盘 SOP
│   │   ├── architecture-fitness.md # 架构健康度
│   │   └── tooling-landscape.md    # 工具全景
│   └── README.md                   # 三层总览
├── .env.example                    # 环境变量模板
├── .gitignore
├── CHECKPOINT.md                   # 项目轨迹档案（rolling 基线 + 迭代历史 + 待办）
├── LESSONS.md                      # 经验决算（核心原则 + 资产清单 + 迁移步骤）
└── README.md                       # 本文件

脚手架状态：

✅ .codebuddy/ 三层框架完整
✅ LESSONS.md §二 反模式表已建立（A5 + B10 = 15 条）
✅ CHECKPOINT.md 轨迹档案已建立（含 4 轮迭代历史，作为新项目迁移的格式样板）
⬜ 业务代码目录（backend/ / frontend/ 等）等待按项目技术栈创建
⬜ CI 流水线配置（.cnb.yml / .github/workflows/）按平台选择生成
⬜ Docker 配置（docker-compose.yml）按需创建
⬜ FB 归档索引空（等待第一次事故/复盘产出）

三层架构

 Leader 视角   ←── .codebuddy/governance/   治理与复盘框架
 Agent 视角    ←── .codebuddy/skills/       可复用工作流模板
 开发者视角    ←── .codebuddy/rules/        强制约束规则
 历史档案      ←── .codebuddy/rules/.archived/feedback/

分层原则：上层不重复下层内容；下层变更不引起上层级联修改；任一层的单条文档都应"拷到新项目可用"。