Skip to content

AGENTS.md

Latest commit

 

History

History
48 lines (34 loc) · 2.1 KB

AGENTS.md

File metadata and controls

48 lines (34 loc) · 2.1 KB
Raw

Web Model SDK Governance

Scope

This portal is the control plane for the versioned Web Model SDK standard. Read standards/v1/README.md before any task involving a single SDK, Demo, portal, Workflow, examples, UI, release, or audit.

Read Order

  1. Read standards/v1/README.md and the linked contract for the affected layer.
  2. Read standards/v1/rules.yaml and the manifest schema when adding or auditing fields.
  3. Read the relevant Skill reference only when the task is scaffold, audit, migrate, or portal routing.

Layer Classification

Classify changes as single SDK, portal, or Workflow before editing. A single SDK owns its runtime and current-model Demo. The portal indexes, categorizes, compares, and links independent SDKs. Workflow work connects multiple SDKs only after compatible contracts and a real use case are documented. Portal code must not copy a single SDK runtime.

Required Workflow

Run pnpm sdk:check -- --repo <path> before and after changing an SDK. Use templates for new manifests, README files, Demo checklists, and release notes. If a new requirement is needed, update standards/v1/rules.yaml, the schema, or the UI tokens before changing product code. Keep evidence paths and remediation in reports.

Editing Rules

  • Keep the standard source in standards/v1; do not duplicate rules in portal components or SDK-specific prose.
  • Use standards/v1/ui-tokens.json for shared colors, spacing, radius, focus, and state semantics.
  • Keep SDK runtime framework-neutral; React is a reference Demo, not a runtime dependency.
  • Do not turn a single SDK Demo into a catalog or copy another SDK's inference code into the portal.
  • Preserve user changes and avoid remote GitHub mutations unless the request explicitly includes them.

Verification

Run the checker plus the relevant package tests, portal checks, build, and browser smoke tests. Do not claim compatibility beyond dated verification evidence. Preserve unrelated user changes and do not perform remote GitHub mutations without explicit scope.

Runner

如需启动或检查 self-hosted runner，工作目录为 F:\github-runner。