feat: 初始化 SCALE OS 工程框架
- 添加 SCALE Engine 配置 (.scale/) - 添加 OpenClaw Agent 配置 (.openclaw/) - 添加知识文档 (AGENTS.md, TOOLS.md) - 添加质量契约和工作流配置 - 添加 22 个工作流模板 - 添加验证脚本和门控脚本 - 添加 skills-registry 技能注册表
This commit is contained in:
61
docs/workflow/templates/product-smoke.md
Normal file
61
docs/workflow/templates/product-smoke.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# Product Smoke
|
||||
|
||||
## Real Product Path
|
||||
|
||||
Describe the smallest end-to-end path that proves the change works through the real product boundary.
|
||||
|
||||
Example:
|
||||
|
||||
```text
|
||||
UI or client -> gateway/router -> service -> database/storage/queue -> observable result
|
||||
```
|
||||
|
||||
Do not use a green health endpoint as the only proof when the user-facing path depends on routing, authentication, storage, async tasks, browser behavior, or third-party integration.
|
||||
|
||||
## Quick Setup
|
||||
|
||||
1. Open `.scale/product-smoke.json`.
|
||||
2. Replace the example command with one real product path command.
|
||||
3. Set that probe's `enabled` field to `true`.
|
||||
4. Run `scale preflight --profile productSmoke --json`.
|
||||
5. Run `scale runtime final-check --level M --json`.
|
||||
|
||||
`status: "skipped"` means no real product path was exercised. It does not count as completion evidence.
|
||||
|
||||
## Setup
|
||||
|
||||
- Base URL:
|
||||
- Test user or tenant:
|
||||
- Required fixtures:
|
||||
- Services that must be running:
|
||||
|
||||
## Smoke Commands
|
||||
|
||||
| Command | Expected Result | Evidence Artifact |
|
||||
| --- | --- | --- |
|
||||
| TBD | TBD | TBD |
|
||||
|
||||
## Runtime Evidence
|
||||
|
||||
Record at least one runtime evidence item:
|
||||
|
||||
```bash
|
||||
scale runtime record \
|
||||
--kind command \
|
||||
--title "Product smoke: <flow>" \
|
||||
--status passed \
|
||||
--command "<exact smoke command>" \
|
||||
--exit-code 0 \
|
||||
--summary "<business result, task id, status, or observable output>" \
|
||||
--artifacts ".agent/logs/<service>/<smoke>.json" \
|
||||
--metadata-json '{"productSmoke":true,"realProductPath":true}'
|
||||
```
|
||||
|
||||
## Assertions
|
||||
|
||||
- [ ] Request crossed the real product boundary, not only an isolated unit.
|
||||
- [ ] Authentication or user identity path was exercised when relevant.
|
||||
- [ ] Persistence/storage/queue side effect was verified when relevant.
|
||||
- [ ] Async task or eventual state was polled to terminal status when relevant.
|
||||
- [ ] Failure output is specific enough to diagnose the failing layer.
|
||||
- [ ] Runtime artifacts are ignored or deliberately promoted according to resource governance.
|
||||
Reference in New Issue
Block a user