File tree Expand file tree Collapse file tree
docs_build/dev/ProjectInstructions
project-instructions/addendums Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -46,3 +46,4 @@ Addendum index:
4646- Test Structure Standardization: project-instructions/addendums/test-structure-standardization.md
4747- Legacy Migration Policy: project-instructions/addendums/legacy-migration-policy.md
4848- Assistant Execution Modes: project-instructions/addendums/assistant-execution-modes.md
49+ - Codex Artifact and Reporting Standard: project-instructions/addendums/codex-artifact-and-reporting-standard.md
Original file line number Diff line number Diff line change 1+ # Codex Artifact and Reporting Standard
2+
3+ ## Purpose
4+
5+ Standardize Codex deliverables, completion reporting, and artifact generation.
6+
7+ ## ZIP Artifact Requirement
8+
9+ Every Codex task must produce a ZIP artifact.
10+
11+ Applies to:
12+ - Success
13+ - Failure
14+ - Stop Gate
15+ - Partial Completion
16+ - Review Deliverables
17+ - Governance Deliverables
18+
19+ Minimum ZIP contents:
20+ - summary.md
21+
22+ Optional:
23+ - changed-files.txt
24+ - findings.md
25+ - validation.txt
26+ - generated artifacts
27+
28+ ## Completion Reporting
29+
30+ Codex responses must include:
31+ - ZIP filename
32+ - ZIP location
33+ - PR number(s)
34+ - Merge commit(s)
35+ - Validation results
36+
37+ ## Code Change Reporting
38+
39+ When a ZIP is uploaded, report executable code changes only.
40+
41+ Report format:
42+
43+ ``` text
44+ {relative path} — {added|updated|deleted}
45+ ```
46+
47+ Examples:
48+
49+ ``` text
50+ toolbox/text-to-speech/index.html — updated
51+ assets/toolbox/text-to-speech/js/index.js — added
52+ tests/toolbox/text-to-speech/functional.spec.mjs — updated
53+ ```
54+
55+ Do not report:
56+ - markdown
57+ - documentation
58+ - reports
59+ - notes
60+ - README updates
61+
62+ unless explicitly requested.
63+
64+ ## No ZIP Means Incomplete
65+
66+ A task is not considered complete until the ZIP artifact is generated and reported.
You can’t perform that action at this time.
0 commit comments