diff --git a/docs_build/dev/ProjectInstructions/README.txt b/docs_build/dev/ProjectInstructions/README.txt index a520a1f2c..c1b401225 100644 --- a/docs_build/dev/ProjectInstructions/README.txt +++ b/docs_build/dev/ProjectInstructions/README.txt @@ -46,3 +46,4 @@ Addendum index: - Test Structure Standardization: project-instructions/addendums/test-structure-standardization.md - Legacy Migration Policy: project-instructions/addendums/legacy-migration-policy.md - Assistant Execution Modes: project-instructions/addendums/assistant-execution-modes.md +- Codex Artifact and Reporting Standard: project-instructions/addendums/codex-artifact-and-reporting-standard.md diff --git a/project-instructions/addendums/codex-artifact-and-reporting-standard.md b/project-instructions/addendums/codex-artifact-and-reporting-standard.md new file mode 100644 index 000000000..3f16a3641 --- /dev/null +++ b/project-instructions/addendums/codex-artifact-and-reporting-standard.md @@ -0,0 +1,66 @@ +# Codex Artifact and Reporting Standard + +## Purpose + +Standardize Codex deliverables, completion reporting, and artifact generation. + +## ZIP Artifact Requirement + +Every Codex task must produce a ZIP artifact. + +Applies to: +- Success +- Failure +- Stop Gate +- Partial Completion +- Review Deliverables +- Governance Deliverables + +Minimum ZIP contents: +- summary.md + +Optional: +- changed-files.txt +- findings.md +- validation.txt +- generated artifacts + +## Completion Reporting + +Codex responses must include: +- ZIP filename +- ZIP location +- PR number(s) +- Merge commit(s) +- Validation results + +## Code Change Reporting + +When a ZIP is uploaded, report executable code changes only. + +Report format: + +```text +{relative path} — {added|updated|deleted} +``` + +Examples: + +```text +toolbox/text-to-speech/index.html — updated +assets/toolbox/text-to-speech/js/index.js — added +tests/toolbox/text-to-speech/functional.spec.mjs — updated +``` + +Do not report: +- markdown +- documentation +- reports +- notes +- README updates + +unless explicitly requested. + +## No ZIP Means Incomplete + +A task is not considered complete until the ZIP artifact is generated and reported.