@haiyangbg/buildbeat 3.3.1 → 4.0.0

package/templates/contracts/PROTOCOL.md

@@ -1,28 +0,0 @@
-# <项目名> 跨边界契约 · PROTOCOL(SSOT)
-
-> **这是跨仓/跨服务边界唯一的契约入口。** 谁改接口行为,先改这里;谁要接接口,先读这里。
-> 🔴 规则:**协议变更不照单全收** —— 用 实测 / 读对端代码 / 查部署配置 独立核查后再信,并在 §3 登记一行。
-> 🔴 本文件**不含任何 key / 凭据明文**。
-> 同仓内部的"前后端"接口优先用**共享类型/schema 由编译器强制**,不进本文件;本文件只管跨服务、跨语言、跨部署单元的边界。
-
-**契约快照对应版本:`<vX.Y.Z>`**(<上线日期>)。
-> 🔴 **线上实况唯一查询口 = `buildbeat observe status --repo .` 与部署平台实查**;本行只标「本快照写就时对应的版本」,其它文档一律不写「当前线上 vX」(AGENTS ⑨)。
-
-> 多仓项目在 §1 按边界逐一列出参与的仓与部署单元;版本对齐由 `release-readback` 车道在上线前后回读,不靠目录名或自然语言猜。
-
----
-
-## 1. 当前契约快照
-
-### <边界A:服务X ↔ 服务Y>
-| 端点/字段 | 行为 | 备注 |
-|---|---|---|
-| | | |
-
-## 2. 🔴 当前关键对齐点(开工前各域必须一致)
-1. <对齐点>
-
-## 3. 契约变更记录(changelog · 倒序)
-| 版本 | 日期 | 变更 | 独立核查 |
-|---|---|---|---|
-| | | | <怎么核的:实测命令/代码行/配置查询> |

package/templates/pm/adr/ADR-0000-template.md

@@ -1,25 +0,0 @@
-# ADR-0000: <标题>
-
-- Status: Proposed
-- Date: <yyyy-mm-dd>
-- Superseded by: n/a
-
-## Context
-
-<为什么现在必须做这个长期技术决定>
-
-## Decision
-
-<最终选择及其边界>
-
-## Consequences
-
-<正向、负向与回滚影响>
-
-## Alternatives considered
-
-<方案 A / B / C 及未选原因>
-
-## Related contracts / work packages / evidence
-
-<工作包 / 契约 / evidence 路径或 n/a>

package/templates/pm/adr/README.md

@@ -1,15 +0,0 @@
-# ADR 使用约定
-
-ADR 只承载长期、难回退的技术决定；普通产品拍板、门前决策卡、短期可逆选择继续写在 `pm/decisions.md`。
-
-满足任一条件时建议从 `ADR-0000-template.md` 复制一份新文件：
-
-1. 改变核心运行时、框架、数据库或部署方式；
-2. 改变跨服务或跨仓架构；
-3. 改变关键数据模型或公共接口策略；
-4. 形成长期、难以回退的技术约束；
-5. 推翻或替代此前 ADR。
-
-命名使用 `ADR-NNNN-kebab-case.md`，编号单调递增。Status 只允许 `Proposed / Accepted / Rejected / Superseded`。若为 Superseded，必须填写一个存在的仓库根相对路径，例如 `pm/adr/ADR-0002-new-choice.md`；新 ADR 解释替代原因，旧 ADR 保留不删除。
-
-ADR 收敛后仍在 `pm/decisions.md` 追加一行索引，指向 ADR 和实际回写落点；ADR 不管理团队成员、审批人或组织权限。

package/templates/pm/decisions.md

@@ -1,11 +0,0 @@
-# decisions — 拍板台账(全工作区唯一决策单点)
-
-> **规则(AGENTS ⑨ 单点事实)**:一个真实决策包收敛后,**第一动作 = 在此追加一行**(倒序),然后才去回写受影响的 SSOT(契约/设计稿/intent/plan);「回写」列登记落点,没回写完 = 欠账可见。单个独立决定也可以是一项决策包。Run 级批准不进这里,它们由内核落在各 Work 的 `decisions.jsonl`。
-> 验收项先分成「人必须取舍的独立变量」与「由已选变量/现有契约推导的约束」:只记录前者;后者直接回写并随候选验收。`3/14 → 11/14 → 14/14` 之类部分进度只留在 Work 的 intent/plan 草稿或门前决策卡里,不得制造三条永久拍板。
-> 决策单元沿用决策卡的包ID;用户分轮回答或要求解释时不换号,直到整包收敛后在本表出现一次。
-> 改变核心技术栈、跨仓架构、关键数据模型或长期难回退约束时，按 pm/adr/README.md 建独立 ADR；本表仍追加一行 ADR 索引与实际回写落点。未启用 ADR 目录时不因此报错。
-> 「拍板人」单人项目就固定写你的名/代号;多人或要审计时(合并决定与上线关窗未必同一人批),谁批的由此可查。
-
-| 日期 | 拍板人 | 决策包 | 回写(落点 → 状态) |
-|---|---|---|---|
-| <yyyy-mm-dd> | <谁> | 【<包ID>】<默认 2–5 个真实取舍的收敛结论;单项决定直接写一句> | <文件/落点> → ✅/⏳ |

package/templates/standards/CODE.md

@@ -1,23 +0,0 @@
-# CODE.md — <项目名> 代码与安全规范
-
-> **Optional**: 本文件由项目拥有；缺失时 BuildBeat 直接跳过，不作为告警或错误。
-> **AI write boundary**: 默认只读；普通需求、修构建或装依赖不得顺手改规范，只有用户明确要求或批准规范变更时才可修改。
-> **Status**: Draft
-
-## 项目约定
-
-- 代码组织与命名：<代码组织与命名约定>
-- 项目特有禁止事项：<项目特有禁止事项>
-
-## Rules
-
-- `CODE-MUST-001`: Secret、访问令牌、真实身份数据和生产配置值不得进入 Git、日志、测试夹具或交付证据。
-- `CODE-MUST-002`: 鉴权、租户隔离、输入校验、持久化和不可逆副作用必须 fail-closed，并有对应测试或显式未验证边界。
-- `CODE-MUST-003`: 公共接口、数据模型或兼容性语义变化必须先同步契约；不得用实现细节偷偷改写已冻结行为。
-- `CODE-MUST-004`: 新依赖必须核对来源、许可证、锁文件和已知安全风险；不得绕过项目既有供应链检查。
-- `CODE-SHOULD-001`: 错误处理应保留可定位上下文，但不得回显 Secret、个人数据或内部凭据值。
-- `CODE-MAY-001`: 不改变外部语义的局部风格改进可随工作包完成，但不得制造与现有代码库不一致的新体系。
-
-## 偏离规则
-
-MUST 偏离必须在人批的转换（plan / merge / release）前形成真实决策；SHOULD 偏离需在 Review 证据中写明理由；MAY 不构成阻断项。

package/templates/standards/DESIGN.md

@@ -1,36 +0,0 @@
-# DESIGN.md — <项目名> UI / 视觉 / 交互规范
-
-> **Optional**: 仅有 UI、视觉或交互交付的项目按需创建；缺失时 BuildBeat 直接跳过，不作为告警或错误。
-> **AI write boundary**: 默认只读；普通页面实现不得顺手重写设计系统，只有用户明确批准设计语言变化或项目首次确认本规范时才可修改。
-> **Status**: Draft
-
-## Principles
-
-<设计原则>
-
-## Tokens
-
-<排版 / 色彩 / 间距 token 来源>
-
-## Components
-
-<核心组件与复用边界>
-
-## Interaction Patterns
-
-- `DESIGN-MUST-001`: 关键操作提供即时、明确且可访问的反馈；不得只靠颜色区分状态。
-- `DESIGN-MUST-002`: 上线界面不得出现调试信息、实现说明、mock 标记或写给开发者的元注释。
-
-## States
-
-- `DESIGN-MUST-003`: 每个可见流程必须处理 loading、empty、error、disabled 和适用的移动端状态。
-
-## Accessibility
-
-- `DESIGN-MUST-004`: 键盘路径、焦点、语义标签、对比度和减弱动态效果必须进入真渲染走查。
-
-## Project-specific exceptions
-
-<项目特有例外>
-
-设计拍板与上线前终签以真渲染可点结果为准；静态稿或规范数值不能替代实际走查。

package/templates/standards/REVIEW.md

@@ -1,20 +0,0 @@
-# REVIEW.md — <项目名> Review 规范
-
-> **Optional**: 本文件由项目拥有；缺失时 BuildBeat 直接跳过，不作为告警或错误。
-> **AI write boundary**: 默认只读；只在项目 Review 口径被明确改变时修改，不用它记录成员、岗位、响应 SLA 或审批人。
-> **Status**: Draft
-
-## 最小检查维度
-
-- `REVIEW-MUST-001`: 核对规格、非目标、验收条件与实现行为，不以“测试绿”替代需求覆盖。
-- `REVIEW-MUST-002`: 核对契约、架构、数据与兼容性变化是否同步，并明确不可外推的未验证范围。
-- `REVIEW-MUST-003`: 核对受影响自动化测试、真渲染走查和 evidence；完成声明必须可追溯到候选与证据。
-- `REVIEW-MUST-004`: 核对 Secret、鉴权、租户、输入、持久化、依赖与不可逆副作用风险。
-- `REVIEW-SHOULD-001`: 识别不必要复杂度、重复抽象、不可维护分支和缺少回滚路径的设计。
-- `REVIEW-SHOULD-002`: 核对 intent / plan、decisions 与交付候选一致，不把旧报告复用于变化后的候选。
-
-## 项目增量
-
-<项目特有 Review 条件>
-
-review 何时跑、跑几轮、哪些 finding 阻断，以 run 配置（`reviewTriage`、`budgets`）与 `AGENTS.md` 为准，本文件不新建第二套流程。

package/templates/standards/STACK.md

@@ -1,31 +0,0 @@
-# STACK.md — <项目名> 技术栈约束
-
-> **Optional**: 本文件由项目拥有；缺失时 BuildBeat 直接跳过，不作为告警或错误。
-> **AI write boundary**: 默认只读；首次 Bootstrap 只能依据可观测事实起草，用户确认或明确要求技术栈变化后才可修改已确认内容。
-> **Status**: Draft
-
-## 声明
-
-| 维度 | 项目约束 | 事实来源 |
-|---|---|---|
-| Runtime | <运行时及版本约束> | 版本文件 / 包清单 / CI |
-| 包管理器 | <包管理器及 lockfile> | lockfile / 包清单 |
-| 语言与框架 | <主要语言与框架> | 依赖与源码入口 |
-| 数据设施 | <数据库 / 缓存 / 消息设施> | 配置 schema / 部署配置 |
-| 部署 | <部署平台 / 容器基线> | Dockerfile / 平台配置 |
-| CI 与测试 | <CI 与测试命令> | CI workflow / 测试配置 |
-| 供应链 | <许可证 / 供应链约束> | LICENSE / lockfile / 安全策略 |
-
-## 可核对事实
-
-上表每一行都要能指回一个仓库事实（`.nvmrc` / `engines.node`、lockfile 文件名、Dockerfile `FROM` 镜像等）。不确定的值保留占位符或标 `n/a`，不猜。Run 配置里的 `requires:`（command / probe）是这些事实的可执行形态，起跑前 fail-closed。
-
-## Rules
-
-- `STACK-MUST-001`: 声明状态与 package、lockfile、版本文件、容器和部署配置等可观测状态冲突时，只报告漂移，不自动改代码或本文件。
-- `STACK-MUST-002`: 更换核心运行时、框架、数据库、包管理器或部署平台前，必须建立 ADR，并同步 `contracts/PROTOCOL.md` 中受影响的跨边界事实。
-- `STACK-SHOULD-001`: 版本约束应尽量指向一个可重复核对的仓库事实，无法确认的内容保留为 Draft，不靠猜测补齐。
-
-## 变更记录
-
-确认后将头部 Status 改为 `Confirmed`；后续变化在 `pm/decisions.md` 留索引，满足 ADR 判据时同时新增 ADR。