Skip to content

docs(quality): deepen quality scorecard terminology parity#3216

Open
ootakazuhiko wants to merge 2 commits intomainfrom
feat/3215-quality-scorecard-terminology
Open

docs(quality): deepen quality scorecard terminology parity#3216
ootakazuhiko wants to merge 2 commits intomainfrom
feat/3215-quality-scorecard-terminology

Conversation

@ootakazuhiko
Copy link
Copy Markdown
Collaborator

Summary

  • refine Japanese terminology in docs/quality/quality-scorecard.md
  • keep the artifact contract and English section unchanged
  • refresh lastVerified only for this docs-only terminology follow-up

Validation

  • pnpm -s run check:doc-consistency
  • pnpm -s run check:ci-doc-index-consistency
  • DOCTEST_ENFORCE=1 /home/devuser/work/CodeX/ae-frameworkA/ae-framework/node_modules/.bin/tsx /home/devuser/work/CodeX/ae-frameworkA/ae-framework/scripts/doctest.ts docs/quality/quality-scorecard.md docs/agents/commands.md
  • git diff --check

Copilot AI review requested due to automatic review settings April 8, 2026 11:49
@github-actions github-actions bot added the risk:low Low risk PR (auto-merge candidate) label Apr 8, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 8, 2026

Generate Artifacts Preview

Generated at: 2026-04-08T12:04:43.636Z

  • tests/api/generated: clean
  • artifacts/codex: clean
  • artifacts/spec: clean

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 8, 2026

Coverage: n/a | Alerts: none | Formal: n/a | BDD: 3 criteria (Reserve inventory without going negative or double-booking) | LTL sugg: 3 | GWT: 0 | Adapters ok/warn/err=0/0/0 | | Replay: n/a | Trace:

Harness Health

  • severity: ok
  • source: workflow=PR Maintenance, runId=24134341017, sha=d20d1391474bb25bdd3f82ea4964905950ddd66c
Gate Status Checks
artifactsSchema skip 0
testingHarness skip 0
contextPack skip 0
runtimeConformance skip 0
ciExtended skip 0
uiE2E skip 0

Change Package

  • risk=risk:low (inferred=risk:low) | files=0 | areas=unknown | evidence=1/4 present/missing
  • required labels: (none) | missing: (none)
  • reproducibility: pnpm run verify:lite

Change Package Validation

  • result: WARN
  • strict: false
  • schema: PASS
  • required evidence: verifyLiteSummary
  • missing required evidence: verifyLiteSummary
  • evidence present/missing(actual): 1/4
  • warnings:
    • missing required evidence: verifyLiteSummary

Plan Artifact

  • goal: Define plan-artifact/v1 and require it for high-risk PR pre-review.
  • scope: Add schema, generator, validator, policy-gate enforcement, PR summary integration, and operator documentation.
  • risk: risk:high
  • approvals required: 1
  • source: feat(ci): add high-risk plan artifact contract #2544 (main <- feat/2535-plan-artifact)

Assumptions

  • A1: High-risk PRs can commit plan artifacts under artifacts/plan before review.
  • A2: policy-gate checkout contains committed plan artifacts from the PR branch.

Files expected to change

  • schema/plan-artifact.schema.json
  • scripts/plan-artifact/generate.mjs
  • scripts/plan-artifact/validate.mjs
  • scripts/ci/policy-gate.mjs
  • .github/workflows/policy-gate.yml
  • .github/workflows/pr-ci-status-comment.yml
  • docs/ci/plan-artifact.md

Verification plan

  • V1: Contract and unit tests
    • command: pnpm exec vitest run tests/contracts/plan-artifact-contract.test.ts tests/unit/ci/plan-artifact-generate.test.ts tests/unit/ci/plan-artifact-validate.test.ts tests/unit/ci/risk-policy.test.ts tests/unit/ci/policy-gate.test.ts
    • expected evidence: tests/contracts/plan-artifact-contract.test.ts, tests/unit/ci/policy-gate.test.ts
  • V2: Schema and docs validation
    • command: node scripts/ci/validate-json.mjs && pnpm -s run check:doc-consistency && pnpm -s run check:ci-doc-index-consistency
    • expected evidence: fixtures/plan/sample.plan-artifact.json, docs/ci/plan-artifact.md

Rollback plan

Revert the plan-artifact schema, scripts, policy-gate integration, and PR summary wiring.

Required human input

  • Confirm the high-risk review scope before implementation proceeds.
  • Approve the required verification and rollback plan for the PR.

Notes

  • Change Package remains the after-change evidence artifact; this contract only covers before-change review.

Plan Artifact Validation

  • result: PASS

  • input: /home/runner/work/ae-framework/ae-framework/artifacts/plan/plan-artifact.json

  • schema: /home/runner/work/ae-framework/ae-framework/schema/plan-artifact.schema.json

  • policy: /home/runner/work/ae-framework/ae-framework/policy/risk-policy.yml

  • no issues

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 8, 2026

Progress Summary

  • Missing: metrics, quality, traceability, phaseState

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 8, 2026

KvOnce Trace Validation

  • OTLP: ✅ Success (Issues: 0)
  • NDJSON: ✅ Success (Issues: 0)

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Japanese wording in the Quality Scorecard documentation to improve terminology parity while keeping the English section and contract references intact.

Changes:

  • Refreshed lastVerified in the frontmatter.
  • Refined Japanese terminology (e.g., clarifying “read-only”, “report-only”, and “legacy” wording) for better consistency/clarity.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@ootakazuhiko ootakazuhiko force-pushed the feat/3215-quality-scorecard-terminology branch from 3e8f5d3 to e121e51 Compare April 8, 2026 12:03
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 8, 2026

CI Status Snapshot (2026-04-09T19:25:04.619Z)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

risk:low Low risk PR (auto-merge candidate)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants