Skip to content

docs(quality): deepen issue traceability terminology parity#3218

Merged
ootakazuhiko merged 3 commits intomainfrom
feat/3217-issue-traceability-terminology
Apr 10, 2026
Merged

docs(quality): deepen issue traceability terminology parity#3218
ootakazuhiko merged 3 commits intomainfrom
feat/3217-issue-traceability-terminology

Conversation

@ootakazuhiko
Copy link
Copy Markdown
Collaborator

Summary

  • refine Japanese terminology in docs/quality/issue-requirements-traceability.md
  • keep the CLI contract and English section unchanged
  • adjust example fences from ts to text so doctest matches the documentation intent

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/issue-requirements-traceability.md docs/agents/commands.md
  • git diff --check

Copilot AI review requested due to automatic review settings April 8, 2026 12:06
@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-10T08:37:46.142Z

  • 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=24234309239, sha=0b02ebae7ef35d4918863c7054c61b49dceeb57e
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

This PR updates the Japanese wording in the quality guide for issue→requirements traceability while keeping the English/CLI contract intact, and adjusts example code fences to better match doctest/documentation intent.

Changes:

  • Update lastVerified and refine Japanese terminology/phrasing for traceability steps.
  • Change example fences from ts to text for non-executable comment examples.
  • Keep the English section and CLI examples unchanged.

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 8, 2026

CI Status Snapshot (2026-04-10T08:06:28.940Z)

@github-actions
Copy link
Copy Markdown
Contributor

CI Auto Rerun

Workflow Verify Lite failed on attempt 1.
Triggered a one-time rerun of failed jobs for run 24234009251.
If it fails again, please investigate the root cause.

@ootakazuhiko ootakazuhiko force-pushed the feat/3217-issue-traceability-terminology branch from 563a0b6 to e27c37b Compare April 10, 2026 08:36
@ootakazuhiko ootakazuhiko merged commit f4791f3 into main Apr 10, 2026
24 checks passed
@ootakazuhiko ootakazuhiko deleted the feat/3217-issue-traceability-terminology branch April 10, 2026 08:38
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