feat: 初始化 SCALE OS 工程框架
- 添加 SCALE Engine 配置 (.scale/) - 添加 OpenClaw Agent 配置 (.openclaw/) - 添加知识文档 (AGENTS.md, TOOLS.md) - 添加质量契约和工作流配置 - 添加 22 个工作流模板 - 添加验证脚本和门控脚本 - 添加 skills-registry 技能注册表
This commit is contained in:
35
docs/workflow/QUALITY_CONTRACT.md
Normal file
35
docs/workflow/QUALITY_CONTRACT.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# 质量契约 (Quality Contract)
|
||||
|
||||
## 概述
|
||||
本文档定义 eskin-model-player 项目的质量标准和交付要求。
|
||||
|
||||
## 门控检查
|
||||
|
||||
### Pre-commit(提交前)
|
||||
| 检查项 | 命令 | 必须通过 |
|
||||
|--------|------|----------|
|
||||
| 类型检查 | `cargo check` | ✅ |
|
||||
| Lint | `cargo clippy -- -D warnings` | ✅ |
|
||||
| 单元测试 | `cargo test` | ✅ |
|
||||
|
||||
### Pre-push(推送前)
|
||||
| 检查项 | 命令 | 必须通过 |
|
||||
|--------|------|----------|
|
||||
| Release 构建 | `cargo build --release` | ✅ |
|
||||
| 完整测试 | `cargo test --all` | ✅ |
|
||||
|
||||
### 代码审查规则
|
||||
- ❌ 禁止裸 `unwrap()` — 使用 `expect("原因")` 或 `?` 运算符
|
||||
- ❌ 禁止 `todo!()` / `unimplemented!()` — 生产代码必须完整实现
|
||||
|
||||
## 质量指标
|
||||
| 指标 | 标准 |
|
||||
|------|------|
|
||||
| 圈复杂度 | ≤ 15 |
|
||||
| 文件行数 | ≤ 500 行 |
|
||||
| 函数行数 | ≤ 80 行 |
|
||||
|
||||
## 交付承诺
|
||||
1. **诚实交付**:所有验证必须真实运行,未验证项必须明确列出
|
||||
2. **逐步验证**:每完成一步,运行相关验证命令
|
||||
3. **知识沉淀**:将经验写入 AGENTS.md 和 TOOLS.md
|
||||
187
docs/workflow/README.md
Normal file
187
docs/workflow/README.md
Normal file
@@ -0,0 +1,187 @@
|
||||
# . Workflow
|
||||
|
||||
Governance mode: standard
|
||||
Governance pack: standard
|
||||
|
||||
## Task Levels
|
||||
|
||||
| Level | Use for | Required artifacts |
|
||||
| --- | --- | --- |
|
||||
| S | typo, comments, small local edits | relevant validation only |
|
||||
| M | bug fixes, new APIs, 2-5 files | explore, skill plan, plan, verification, review, summary |
|
||||
| L | cross-module or architecture changes | full artifacts plus human confirmation |
|
||||
| CRITICAL | auth, permissions, migrations, production config | rollback plan, security review, full verification |
|
||||
|
||||
## Standard Task Directory
|
||||
|
||||
```text
|
||||
.planning/tasks/<yyyy-mm-dd>-<task-slug>/
|
||||
├── explore.md
|
||||
├── mini-prd.md
|
||||
├── plan.md
|
||||
├── runtime.md
|
||||
├── reality-check.md
|
||||
├── resource-cleanup.md
|
||||
├── verification.md
|
||||
├── review.md
|
||||
├── summary.md
|
||||
├── artifact-manifest.json
|
||||
└── artifacts/
|
||||
├── index.html
|
||||
└── release-report.html
|
||||
```
|
||||
|
||||
## Verification
|
||||
|
||||
Use service-aware verification when configured:
|
||||
|
||||
```bash
|
||||
scale preflight --service all
|
||||
scale preflight --service all --preflight-profile full
|
||||
scale verify <task-id> --profile default
|
||||
scale verify <task-id> --service <service-name>
|
||||
scale verify <task-id> --artifact-gate warn
|
||||
scale verify <task-id> --artifact-gate block
|
||||
scale verify <task-id> --require-installed-skills
|
||||
scale verify <task-id> --profile productSmoke
|
||||
scale task-artifacts check --dir .planning/tasks/<task-dir> --level L
|
||||
scale artifact render --task-id <task-dir> --type release-report
|
||||
scale artifact doctor --task-id <task-dir>
|
||||
```
|
||||
|
||||
Keep `.scale/verification.json` as the source of truth for profiles and service commands.
|
||||
Keep `.scale/skills.json` as the source of truth for active skill routing policy.
|
||||
Keep `.scale/output-policy.json` as the source of truth for derived HTML artifact types, source Markdown mapping, security policy, and Git retention behavior.
|
||||
Keep `.scale/resource-policy.json` and `.scale/assets.json` as the source of truth for generated reports, temporary files, module documentation, media, reusable scripts, and Git retention policy.
|
||||
Keep `.scale/engineering-standards.json` and `.scale/frameworks.json` as the source of truth for logging, security, ORM, architecture, framework, UI/UX, testing, and coding standard checks.
|
||||
Keep `.scale/engineering-standards-baseline.json` as the temporary exception list for known legacy standards findings; it must not be used to hide new or changed-file problems.
|
||||
Use `artifactGate: "warn"` while introducing the workflow, then move M/L/CRITICAL work to `"block"` once templates and local gates are stable.
|
||||
|
||||
## Workflow Upgrade
|
||||
|
||||
Do not rerun `scale init` as a blind upgrade command. Generated governance files may contain local project adaptations.
|
||||
|
||||
Use the guarded upgrade flow:
|
||||
|
||||
```bash
|
||||
scale upgrade check --dir .
|
||||
scale upgrade plan --dir . --html
|
||||
scale upgrade apply --dir . --confirm
|
||||
scale upgrade rollback --dir .
|
||||
scale tools outdated --dir .
|
||||
scale skill outdated --dir .
|
||||
scale preflight --preflight-profile quick
|
||||
```
|
||||
|
||||
Rules:
|
||||
|
||||
- `.scale/governance.lock.json` records generated file hashes and pack versions.
|
||||
- Clean or missing generated files can be planned safely.
|
||||
- Locally changed generated files require manual review before replacement or merge.
|
||||
- `scale upgrade apply --confirm` only restores missing generated files and refreshes the lock after writing `.scale/backups/upgrade-*/manifest.json`.
|
||||
- `scale upgrade rollback` only rolls back the latest SCALE-managed safe apply.
|
||||
- Third-party skills, MCP servers, browser tools, desktop automation, and external CLI tools are never auto-installed by the upgrade flow.
|
||||
- Community sources require source, install script, permission, and changelog review. Desktop automation is treated as high risk.
|
||||
|
||||
## HTML Artifacts
|
||||
|
||||
Markdown remains the editable source of truth for task artifacts. HTML artifacts are derived human-review surfaces for plan comparison, implementation plans, code reviews, status reports, incident reports, and release reports.
|
||||
|
||||
Use HTML when a human needs to compare, review, or sign off. Keep source Markdown, manifest metadata, and safety checks in place so the derived HTML stays traceable and does not leak secrets or remote scripts.
|
||||
|
||||
## Active Skill Routing
|
||||
|
||||
SCALE plans required skills from task description, service selection, and changed files. UI/API work requires a Mini-PRD plus domain evidence such as `ui-spec.md`, `visual-review.md`, or `api-contract.md`. Security and database work require explicit review or rollback artifacts.
|
||||
|
||||
Tool orchestration is part of the workflow contract:
|
||||
|
||||
- UI/UX work requires `frontend-design` and `ui-ux-pro-max`, and should consider `awesome-design-md`, browser screenshots, responsive checks, and visual review evidence.
|
||||
- Web research, logged-in pages, and dynamic browser work require `web-access` evidence, source citations, and browser/network/console evidence when available.
|
||||
- Browser E2E work should combine `webapp-testing`, Playwright, Agent Browser, web-access, or Chrome DevTools MCP according to the target and record screenshots plus console/network findings.
|
||||
- Desktop or client-side GUI automation uses CUA/computer-use only with explicit operator-safety notes, desktop screenshots, and a side-effect boundary.
|
||||
- External agent or CLI orchestration such as Codex, Gemini CLI, OpenCode, WPS, or WeChat automation must record version checks, exact commands, output summaries, and dry-run or safe-mode evidence.
|
||||
|
||||
When a task records `servicesTouched`, `scale verify <task-id>` uses those services automatically. You can still override selection with `--service all`, `--service api`, or `--service api,gateway`.
|
||||
|
||||
Before M/L work, check whether required workflow skills are physically installed:
|
||||
|
||||
```bash
|
||||
scale skill doctor --json
|
||||
scale skill check --require-installed --json
|
||||
```
|
||||
|
||||
## Workspace Lifecycle
|
||||
|
||||
Before finishing an agent-created branch or deleting a temporary worktree, inspect root and child repository state:
|
||||
|
||||
```bash
|
||||
scale workspace status --json
|
||||
scale workspace finish --summary
|
||||
scale workspace finish --json
|
||||
scale workspace cleanup --dir <temporary-worktree> --dry-run --json
|
||||
scale workspace cleanup --dir <temporary-worktree> --apply --confirm <branch-or-head> --json
|
||||
```
|
||||
|
||||
Do not remove a temporary worktree while any submodule or nested repository has uncommitted or unpushed work. Child repositories must be committed and reviewed in their own remotes, then the root repository can record any required pointer or governance updates. Cleanup defaults to dry-run. Applying cleanup requires the reported confirmation token, normally the temporary branch name.
|
||||
|
||||
Use `scale ship <task-id>` for governed commits. It checks MOE/submodule child repository state before staging reviewed root files, so dirty or unpushed child work cannot be hidden inside a root commit. It also enforces the GitLab Flow branch lifecycle: work happens on short branches, merges target `dev`, production lands on `master`, and release publishing is triggered by user-created `vX.Y.Z` tags. Direct governed commits on `dev`, `master`, `main`, or detached HEAD are blocked. Raw `git add .` is outside the governed path and must not be used for MOE releases.
|
||||
|
||||
## Resource Governance
|
||||
|
||||
Use asset scanning before committing generated reports, media, temporary scripts, or long-lived documentation changes:
|
||||
|
||||
```bash
|
||||
scale assets scan --json
|
||||
scale assets doctor --json
|
||||
scale assets settle --task-id <task-id> --artifact-dir .planning/tasks/<task-dir>
|
||||
```
|
||||
|
||||
Default policy:
|
||||
|
||||
- maintained module docs, standards, contracts, ADRs, reusable scripts: commit and keep current.
|
||||
- task planning, verification, runtime-contract, reality-check, and cleanup artifacts: keep in `.planning/tasks`; promote final truth to maintained docs when useful.
|
||||
- screenshots, videos, E2E reports, coverage, temporary scripts, and runtime logs: keep out of Git unless explicitly promoted.
|
||||
- large media: use Git LFS or external artifact storage instead of normal Git history.
|
||||
|
||||
## Engineering Standards
|
||||
|
||||
Use standards scanning before reviewing or shipping M/L/CRITICAL work:
|
||||
|
||||
```bash
|
||||
scale standards scan --json
|
||||
scale standards doctor --json
|
||||
scale standards doctor --changed --json
|
||||
scale standards doctor --changed-files src/example.ts,src/example.test.ts --json
|
||||
scale standards baseline --write --artifact-dir .planning/tasks/<task-dir> --task-id <task-id> --json
|
||||
scale standards settle --task-id <task-id> --artifact-dir .planning/tasks/<task-dir>
|
||||
scale preflight --preflight-profile full --json
|
||||
scale verify <task-id> --json
|
||||
```
|
||||
|
||||
Default policy:
|
||||
|
||||
- ad-hoc console/output logging is allowed only for CLI/script paths.
|
||||
- sensitive fields such as token, password, secret, authorization, cookie, and credentials must not be logged.
|
||||
- hardcoded secret-like assignments are blocked before review or release.
|
||||
- SQL must use parameterized queries, ORM bind parameters, or safe query builders.
|
||||
- unsafe HTML sinks, dynamic code execution, empty catch blocks, and type suppressions require remediation before release.
|
||||
- framework and architecture rules live in `.scale/frameworks.json` and module standards docs.
|
||||
- `.scale/frameworks.json > bannedImports` blocks direct use of deprecated ORMs, unsafe SDKs, or off-system UI components.
|
||||
- `.scale/frameworks.json > lastReviewedAt/reviewIntervalDays` warns when module framework decisions need review.
|
||||
- `.scale/engineering-standards.json > blockingRules` promotes selected warning rule IDs to release-blocking findings.
|
||||
- `.scale/engineering-standards.json > allowedFindingPatterns` allows narrow rule/path/evidence exceptions without hiding unrelated findings in the same file.
|
||||
- `.scale/engineering-standards-baseline.json` may hold known legacy findings during rollout, but normal task gates should prefer `--changed` or `--changed-files` so new work is blocked without forcing a whole-repo cleanup.
|
||||
- `.scale/verification.json > policy.engineeringStandardsGate` controls whether preflight and task verification treat standards as `off`, `warn`, or `block`.
|
||||
- `.scale/product-smoke.json` defines real product-path probes. Use it to prove a routed user/business flow, not only build, unit tests, or `/health`.
|
||||
- `.scale/verification.json > policy.productSmokeGate` controls whether missing or failed product smoke evidence warns or blocks M/L/CRITICAL delivery.
|
||||
- Full standards scans are for release readiness, scheduled remediation, and architecture cleanup. Changed-file scans are the default for day-to-day feature and bug branches.
|
||||
- Use `scale standards baseline --write` only during an explicit rollout or remediation planning task. It writes the machine-readable baseline and a `standards-legacy-debt.md` classification report for staged cleanup.
|
||||
|
||||
## Automation Templates
|
||||
|
||||
Optional automation templates are generated under `docs/workflow/templates/`:
|
||||
|
||||
- `github-actions-scale-preflight.yml`: CI workflow that runs `scale preflight --service all --preflight-profile ci`.
|
||||
- `pre-push-scale-preflight.sh`: local pre-push hook template that runs the default quick preflight.
|
||||
|
||||
Keep these templates advisory until `scale preflight --service all --preflight-profile full` is reliable locally for the project.
|
||||
29
docs/workflow/templates/api-contract.md
Normal file
29
docs/workflow/templates/api-contract.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# API Contract
|
||||
|
||||
## Endpoint Or Interface
|
||||
|
||||
TBD
|
||||
|
||||
## Request
|
||||
|
||||
TBD
|
||||
|
||||
## Response
|
||||
|
||||
TBD
|
||||
|
||||
## Errors
|
||||
|
||||
TBD
|
||||
|
||||
## Permission Rules
|
||||
|
||||
TBD
|
||||
|
||||
## Compatibility Notes
|
||||
|
||||
TBD
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ] TBD
|
||||
23
docs/workflow/templates/architecture-review.md
Normal file
23
docs/workflow/templates/architecture-review.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Architecture Review
|
||||
|
||||
## Scope
|
||||
|
||||
- Modules touched:
|
||||
- Public contracts touched:
|
||||
- Data flow touched:
|
||||
|
||||
## Boundary Checks
|
||||
|
||||
- [ ] API/controller layer does not bypass service/usecase layer
|
||||
- [ ] Domain layer is not coupled to infrastructure details
|
||||
- [ ] Repository/ORM usage follows project conventions
|
||||
- [ ] Shared framework components are reused instead of duplicated
|
||||
- [ ] New abstractions remove real complexity
|
||||
|
||||
## Risks
|
||||
|
||||
- TBD
|
||||
|
||||
## Decision
|
||||
|
||||
- Approved/changes required:
|
||||
20
docs/workflow/templates/db-change-plan.md
Normal file
20
docs/workflow/templates/db-change-plan.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# DB Change Plan
|
||||
|
||||
## Schema Or Data Change
|
||||
|
||||
TBD
|
||||
|
||||
## Backward Compatibility
|
||||
|
||||
TBD
|
||||
|
||||
## Migration Steps
|
||||
|
||||
TBD
|
||||
|
||||
## Rollback Plan
|
||||
|
||||
TBD
|
||||
|
||||
## Verification
|
||||
TBD
|
||||
17
docs/workflow/templates/docs-impact.md
Normal file
17
docs/workflow/templates/docs-impact.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Docs Impact
|
||||
|
||||
## Code Changes Requiring Docs
|
||||
|
||||
- TBD
|
||||
|
||||
## Documentation Updated
|
||||
|
||||
- TBD
|
||||
|
||||
## No-Docs-Needed Rationale
|
||||
|
||||
TBD
|
||||
|
||||
## Links Checked
|
||||
|
||||
- TBD
|
||||
20
docs/workflow/templates/e2e-plan.md
Normal file
20
docs/workflow/templates/e2e-plan.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# E2E Plan
|
||||
|
||||
## User Paths
|
||||
|
||||
TBD
|
||||
|
||||
## Browser Coverage
|
||||
|
||||
TBD
|
||||
|
||||
## Test Data
|
||||
|
||||
TBD
|
||||
|
||||
## Assertions
|
||||
|
||||
TBD
|
||||
|
||||
## Evidence
|
||||
TBD
|
||||
20
docs/workflow/templates/explore.md
Normal file
20
docs/workflow/templates/explore.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Explore
|
||||
|
||||
## Files Read
|
||||
|
||||
- TBD
|
||||
|
||||
## Current Behavior
|
||||
|
||||
TBD
|
||||
|
||||
## Main Conflict
|
||||
|
||||
TBD
|
||||
|
||||
## Affected Modules
|
||||
|
||||
TBD
|
||||
|
||||
## Evidence
|
||||
TBD
|
||||
32
docs/workflow/templates/github-actions-scale-preflight.yml
Normal file
32
docs/workflow/templates/github-actions-scale-preflight.yml
Normal file
@@ -0,0 +1,32 @@
|
||||
name: SCALE Preflight
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- master
|
||||
|
||||
jobs:
|
||||
preflight:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '20'
|
||||
|
||||
- name: Install project dependencies when present
|
||||
shell: bash
|
||||
run: |
|
||||
if [ -f package-lock.json ]; then
|
||||
npm ci
|
||||
elif [ -f package.json ]; then
|
||||
npm install
|
||||
fi
|
||||
|
||||
- name: Run SCALE preflight
|
||||
run: npx @hongmaple0820/scale-engine@latest preflight --service all --preflight-profile ci
|
||||
42
docs/workflow/templates/mini-prd.md
Normal file
42
docs/workflow/templates/mini-prd.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# Mini-PRD
|
||||
|
||||
## Background
|
||||
|
||||
TBD
|
||||
|
||||
## Target Users
|
||||
|
||||
TBD
|
||||
|
||||
## Core Scenario
|
||||
|
||||
TBD
|
||||
|
||||
## Non-Goals
|
||||
|
||||
TBD
|
||||
|
||||
## User Path
|
||||
|
||||
TBD
|
||||
|
||||
## Permission Rules
|
||||
|
||||
TBD
|
||||
|
||||
## Data Impact
|
||||
|
||||
TBD
|
||||
|
||||
## Exception Scenarios
|
||||
|
||||
1. TBD
|
||||
2. TBD
|
||||
3. TBD
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ] TBD
|
||||
|
||||
## Rollback Or Disable Strategy
|
||||
TBD
|
||||
28
docs/workflow/templates/plan.md
Normal file
28
docs/workflow/templates/plan.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Plan
|
||||
|
||||
## Approach
|
||||
|
||||
TBD
|
||||
|
||||
## Boundaries
|
||||
|
||||
TBD
|
||||
|
||||
## Exception Contract
|
||||
|
||||
1. TBD
|
||||
2. TBD
|
||||
3. TBD
|
||||
|
||||
## Rollback Plan
|
||||
|
||||
TBD
|
||||
|
||||
## Human Confirmation
|
||||
|
||||
- Required for L/CRITICAL tasks:
|
||||
- Confirmation source:
|
||||
- Execution boundary approved:
|
||||
|
||||
## Test Strategy
|
||||
TBD
|
||||
8
docs/workflow/templates/pre-push-scale-preflight.sh
Normal file
8
docs/workflow/templates/pre-push-scale-preflight.sh
Normal file
@@ -0,0 +1,8 @@
|
||||
#!/usr/bin/env sh
|
||||
set -eu
|
||||
|
||||
if command -v scale >/dev/null 2>&1; then
|
||||
scale preflight --service all
|
||||
else
|
||||
npx @hongmaple0820/scale-engine@latest preflight --service all
|
||||
fi
|
||||
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.
|
||||
25
docs/workflow/templates/reality-check.md
Normal file
25
docs/workflow/templates/reality-check.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Reality Check
|
||||
|
||||
## Confirmed
|
||||
|
||||
- TBD
|
||||
|
||||
## Not Verified
|
||||
|
||||
- TBD
|
||||
|
||||
## Stub / Fake / Partial
|
||||
|
||||
- TBD
|
||||
|
||||
## Credential-Gated
|
||||
|
||||
- TBD
|
||||
|
||||
## Environment-Gated
|
||||
|
||||
- TBD
|
||||
|
||||
## User-Visible Risk
|
||||
|
||||
- TBD
|
||||
14
docs/workflow/templates/resource-cleanup.md
Normal file
14
docs/workflow/templates/resource-cleanup.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# Resource Cleanup
|
||||
|
||||
## New Resources
|
||||
|
||||
| Resource | Location | Keep / Move / Delete | Reason |
|
||||
| --- | --- | --- | --- |
|
||||
| TBD | TBD | TBD | TBD |
|
||||
|
||||
## Docs Promotion
|
||||
|
||||
- Promote to docs:
|
||||
- Keep in planning:
|
||||
- Keep local/runtime only:
|
||||
- Delete before handoff:
|
||||
25
docs/workflow/templates/resource-impact.md
Normal file
25
docs/workflow/templates/resource-impact.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Resource Impact
|
||||
|
||||
## Resources Created
|
||||
|
||||
| Path | Type | Git Policy | Retention |
|
||||
| --- | --- | --- | --- |
|
||||
| TBD | canonical-doc/task-artifact/evidence-report/temporary/reusable-script/generated-media/contract/decision-record | commit/ignore/lfs/external/review | TBD |
|
||||
|
||||
## Resources Updated
|
||||
|
||||
- TBD
|
||||
|
||||
## Resources Promoted To Maintained Docs
|
||||
|
||||
- TBD
|
||||
|
||||
## Resources To Delete Or Archive Before Finish
|
||||
|
||||
- TBD
|
||||
|
||||
## Source Of Truth Updates
|
||||
|
||||
- [ ] .scale/resource-policy.json
|
||||
- [ ] .scale/assets.json
|
||||
- [ ] docs/modules/<module>/README.md
|
||||
16
docs/workflow/templates/review.md
Normal file
16
docs/workflow/templates/review.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Review
|
||||
|
||||
## Code Review
|
||||
|
||||
TBD
|
||||
|
||||
## Security Review
|
||||
|
||||
TBD
|
||||
|
||||
## Same-Pattern Scan
|
||||
|
||||
TBD
|
||||
|
||||
## Residual Risks
|
||||
TBD
|
||||
21
docs/workflow/templates/runtime.md
Normal file
21
docs/workflow/templates/runtime.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Runtime Contract
|
||||
|
||||
## Configuration Source
|
||||
|
||||
- Source: TBD
|
||||
- Environment/profile: TBD
|
||||
- Runtime overrides: TBD
|
||||
- Secrets boundary: TBD
|
||||
|
||||
## Service Topology
|
||||
|
||||
| Service | URL Or Command | Config Source | Auth Mode | Status |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| TBD | TBD | TBD | TBD | Not checked |
|
||||
|
||||
## Verification Boundary
|
||||
|
||||
- Confirmed:
|
||||
- Not covered:
|
||||
- Credential-gated:
|
||||
- Environment-gated:
|
||||
26
docs/workflow/templates/security-review.md
Normal file
26
docs/workflow/templates/security-review.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# Security Review
|
||||
|
||||
## Assets And Trust Boundaries
|
||||
|
||||
TBD
|
||||
|
||||
## Authorization Rules
|
||||
|
||||
TBD
|
||||
|
||||
## Abuse Cases
|
||||
|
||||
1. TBD
|
||||
2. TBD
|
||||
3. TBD
|
||||
|
||||
## Sensitive Data Impact
|
||||
|
||||
TBD
|
||||
|
||||
## Rollback Or Disable Strategy
|
||||
|
||||
TBD
|
||||
|
||||
## Final Verdict
|
||||
TBD
|
||||
33
docs/workflow/templates/skill-evidence.md
Normal file
33
docs/workflow/templates/skill-evidence.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Skill Evidence
|
||||
|
||||
## Planned Skills
|
||||
|
||||
- TBD
|
||||
|
||||
## Tool Selection Rationale
|
||||
|
||||
TBD
|
||||
|
||||
## Used Skills
|
||||
|
||||
| Skill | Phase | Trigger | Evidence | Status |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| skill-id | plan/build/verify/review | why it was selected | command, screenshot, report, or artifact path | executed/skipped/fallback |
|
||||
|
||||
## Browser Or Web Evidence
|
||||
|
||||
| Tool | Target | Evidence | Result |
|
||||
| --- | --- | --- | --- |
|
||||
| web-access/agent-browser/Chrome DevTools MCP | URL or local target | screenshot, console log, network finding, source URL | passed/failed/skipped |
|
||||
|
||||
## Desktop Or External CLI Evidence
|
||||
|
||||
| Tool | Scope | Safety Boundary | Evidence | Result |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| cua/codex/gemini/opencode/wps/wechat | command or app target | read-only/dry-run/test account/manual approval | output summary, screenshot, or report path | passed/failed/skipped |
|
||||
|
||||
## Skipped Skills
|
||||
|
||||
| Skill | Reason | Fallback Evidence |
|
||||
| --- | --- | --- |
|
||||
| skill-id | why it could not run | manual review, alternate command, or explicit risk |
|
||||
39
docs/workflow/templates/skill-plan.md
Normal file
39
docs/workflow/templates/skill-plan.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# Skill Plan
|
||||
|
||||
## Detected Intents
|
||||
|
||||
| Domain | Score | Evidence |
|
||||
| --- | ---: | --- |
|
||||
| | | |
|
||||
|
||||
## Required Skills
|
||||
|
||||
- TBD
|
||||
|
||||
## Recommended Skills
|
||||
|
||||
- TBD
|
||||
|
||||
## Required Artifacts
|
||||
|
||||
- TBD
|
||||
|
||||
## Required Verification Evidence
|
||||
|
||||
- TBD
|
||||
|
||||
## Tool Orchestration
|
||||
|
||||
| Capability | Primary Tool Or Skill | Fallback | Required Evidence |
|
||||
| --- | --- | --- | --- |
|
||||
| UI/UX design | frontend-design, ui-ux-pro-max | awesome-design-md | design-system, ui-spec.md, visual-review.md |
|
||||
| Web research or logged-in pages | web-access | agent-browser, Chrome DevTools MCP | source citations, browser evidence |
|
||||
| Browser E2E | webapp-testing, Playwright | agent-browser, web-access | screenshot, console, network evidence |
|
||||
| Desktop GUI automation | CUA/computer-use | manual verification | desktop screenshot, operator-safety notes |
|
||||
| External agent CLI | codex/gemini/opencode CLI | manual review | version check, exact command output |
|
||||
|
||||
## Skipped Skills
|
||||
|
||||
| Skill | Reason | Fallback Evidence |
|
||||
| --- | --- | --- |
|
||||
| | | |
|
||||
28
docs/workflow/templates/standards-impact.md
Normal file
28
docs/workflow/templates/standards-impact.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Standards Impact
|
||||
|
||||
## Standards Checked
|
||||
|
||||
- [ ] Logging and redaction
|
||||
- [ ] Architecture boundaries
|
||||
- [ ] ORM/database access
|
||||
- [ ] Framework/component conventions
|
||||
- [ ] UI/UX acceptance where user-facing
|
||||
- [ ] Test and verification rigor
|
||||
- [ ] Security-sensitive inputs and outputs
|
||||
|
||||
## Findings
|
||||
|
||||
| Severity | Rule | Path | Decision |
|
||||
| --- | --- | --- | --- |
|
||||
| TBD | TBD | TBD | fix/accept/escalate |
|
||||
|
||||
## Policy Updates
|
||||
|
||||
- [ ] .scale/engineering-standards.json
|
||||
- [ ] .scale/frameworks.json
|
||||
- [ ] docs/standards/
|
||||
|
||||
## Settlement
|
||||
|
||||
- Standards scan:
|
||||
- Standards doctor:
|
||||
19
docs/workflow/templates/summary.md
Normal file
19
docs/workflow/templates/summary.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Summary
|
||||
|
||||
## Delivered Changes
|
||||
|
||||
TBD
|
||||
|
||||
## Remaining Risks
|
||||
|
||||
TBD
|
||||
|
||||
## Follow-Ups
|
||||
|
||||
TBD
|
||||
|
||||
## Metric Row
|
||||
|
||||
| Date | Task | Level | Services | Files Changed | First Verification Pass | Fix Iterations | Artifact Complete | Residual Risk | Final Gate |
|
||||
| --- | --- | --- | --- | ---: | --- | ---: | --- | --- | --- |
|
||||
| | | | | | | | | | |
|
||||
29
docs/workflow/templates/ui-spec.md
Normal file
29
docs/workflow/templates/ui-spec.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# UI Spec
|
||||
|
||||
## User Goal
|
||||
|
||||
TBD
|
||||
|
||||
## Primary Flow
|
||||
|
||||
TBD
|
||||
|
||||
## Interaction States
|
||||
|
||||
- Default:
|
||||
- Loading:
|
||||
- Empty:
|
||||
- Error:
|
||||
- Success:
|
||||
|
||||
## Responsive Behavior
|
||||
|
||||
TBD
|
||||
|
||||
## Accessibility Requirements
|
||||
|
||||
TBD
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ] TBD
|
||||
18
docs/workflow/templates/verification.md
Normal file
18
docs/workflow/templates/verification.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Verification
|
||||
|
||||
## Commands Run
|
||||
|
||||
| Command | Result | Notes |
|
||||
| --- | --- | --- |
|
||||
| | | |
|
||||
|
||||
## Output Summary
|
||||
|
||||
TBD
|
||||
|
||||
## Failures And Fixes
|
||||
|
||||
TBD
|
||||
|
||||
## Final Status
|
||||
TBD
|
||||
20
docs/workflow/templates/visual-review.md
Normal file
20
docs/workflow/templates/visual-review.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Visual Review
|
||||
|
||||
## Screenshots Or Evidence
|
||||
|
||||
TBD
|
||||
|
||||
## Layout And Responsiveness
|
||||
|
||||
TBD
|
||||
|
||||
## Text Fit And Overlap
|
||||
|
||||
TBD
|
||||
|
||||
## Accessibility Notes
|
||||
|
||||
TBD
|
||||
|
||||
## Final Verdict
|
||||
TBD
|
||||
28
docs/worklog/metrics.md
Normal file
28
docs/worklog/metrics.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Workflow Metrics
|
||||
|
||||
<!-- SCALE_METRICS:START -->
|
||||
| Date | Task | Level | Services | Files Changed | First Verification Pass | Fix Iterations | Rework Needed | Artifact Complete | Residual Risk | Final Gate |
|
||||
| --- | --- | --- | --- | ---: | --- | ---: | --- | --- | --- | --- |
|
||||
| | | | | | | | | | | |
|
||||
<!-- SCALE_METRICS:END -->
|
||||
|
||||
## Monthly Review
|
||||
|
||||
### Repeated Failure Patterns
|
||||
|
||||
TBD
|
||||
|
||||
### Slowest Gates
|
||||
|
||||
TBD
|
||||
|
||||
### Documentation Gaps
|
||||
|
||||
TBD
|
||||
|
||||
### Product Design Misses
|
||||
|
||||
TBD
|
||||
|
||||
### Proposed Workflow Changes
|
||||
TBD
|
||||
Reference in New Issue
Block a user