Skip to content

docs: HUB.codex.md に YAML 出力例を追加し TASKS 対応表を追加#603

Merged
RNA4219 merged 1 commit intomainfrom
codex/add-yaml-output-example-to-hub.codex.md
Mar 3, 2026
Merged

docs: HUB.codex.md に YAML 出力例を追加し TASKS 対応表を追加#603
RNA4219 merged 1 commit intomainfrom
codex/add-yaml-output-example-to-hub.codex.md

Conversation

@RNA4219
Copy link
Copy Markdown
Owner

@RNA4219 RNA4219 commented Mar 3, 2026

Motivation

  • Orchestration から自動生成する Task Seed の出力フォーマットを明確化し、必須キーを固定化するために YAML 例を追加する必要があった。
  • HUB の出力と docs/TASKS.md の必須項目の転記ルールを一元化して自動化パイプラインの安定化を図る目的がある。

Description

  • workflow-cookbook/HUB.codex.md の「出力例」を「出力例(YAML)」へ変更し、例に必須キー task_id, source, objective, requirements, commands, dependencies, status を揃えた。
  • YAML 例に terraform apply -target=module.api_gatewaystatus: planned を追記し、sourceorchestration/<path>.md#Phase... / #Stage... 形式で追跡可能にする旨を明文化した。
  • docs/TASKS.md に HUB 出力キーと Task Seed の須項目との対応表(転記先と転記ルール)を追加し、どのキーがどこへ転記されるかを固定化した。
  • 変更は小規模なドキュメント修正に限定し、既存の公開 API/CI 等には影響を与えない内容でコミット済み。

Testing

  • 自動チェックとして git -C /workspace/Day8 diff --check を実行してエラーなし(成功)。

Codex Task

@RNA4219 RNA4219 merged commit d5703c4 into main Mar 3, 2026
12 checks passed
@RNA4219 RNA4219 deleted the codex/add-yaml-output-example-to-hub.codex.md branch March 3, 2026 13:54
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 49e201e670

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

| `task_id` | 識別情報 `task_id` | 日付ベース連番をそのまま記載 |
| `source` | Notes(出典) | `orchestration/...#Phase...` 形式の参照を原文維持で記録 |
| `objective` | Objective | 1文で転記(意図は変えない) |
| `requirements` | Requirements | `behavior` / `constraints` / 受入基準へ展開 |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Map requirements into I/O Contract as well

The new fixed mapping table omits I/O Contract for requirements, but this same document defines Requirements as including behavior, I/O contract, constraints, and acceptance criteria (手順 2). If automation follows this table as the source of truth, generated Task Seeds can systematically lose input/output contract details and become non-compliant with the template requirements.

Useful? React with 👍 / 👎.

| `requirements` | Requirements | `behavior` / `constraints` / 受入基準へ展開 |
| `commands` | Local Commands / Commands | 検証コマンドを順序維持で列挙 |
| `dependencies` | Plan(着手条件) | 依存 Task ID を着手前提として明記 |
| `status` | メタデータ `status` | `draft|active|...|done` の許容値に正規化 |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Replace ellipsis with explicit status normalization map

This row is under a section labeled as a fixed transfer contract, but draft|active|...|done is not deterministic enough for tooling and leaves intermediate states undefined. In practice, HUB examples now emit values like planned and in_progress, so a generator implementing this rule cannot normalize statuses consistently without guessing, which risks producing inconsistent Task Seed metadata.

Useful? React with 👍 / 👎.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant