Skip to content

Commit 6740a48

Browse files
author
DavidQ
committed
Add PR naming standard and enforce ChatGPT response contract with Playwright + manual testing requirements - PR_26124_XXX-project-instructions-update
1 parent 1c053cc commit 6740a48

4 files changed

Lines changed: 86 additions & 8 deletions

File tree

docs/dev/PROJECT_INSTRUCTIONS.md

Lines changed: 50 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,27 @@ You are working in a docs-first repo workflow.
55
Workflow:
66
PLAN_PR → BUILD_PR → APPLY_PR
77

8+
## PR NAMING STANDARD
9+
10+
PR names MUST follow:
11+
12+
`PR_<YYJJJ>_<###>-<short-description>`
13+
14+
Where:
15+
- `YY` = year (2 digit)
16+
- `JJJ` = Julian day (001–365)
17+
- `###` = sequence for the day (001+)
18+
19+
Example:
20+
- `PR_26124_001-palette-baseline`
21+
- `PR_26124_002-tool-fix-asset-manager`
22+
23+
Rules:
24+
- Must be unique per day
25+
- Must be sortable
26+
- Description must be short and hyphenated
27+
- Do NOT reuse old `PR_11_*` format for new PRs
28+
829
ChatGPT execution role:
930
- ChatGPT no longer creates PLAN_PR, BUILD_PR, APPLY_PR docs, or ZIP bundles.
1031
- ChatGPT produces only the Codex command, commit comment, and how to test the change.
@@ -18,14 +39,36 @@ Rules:
1839
- No repo-wide scanning unless required
1940

2041
Responsibilities:
21-
- ChatGPT: produce the Codex command, commit comment, and how to test the change
42+
- ChatGPT produces:
43+
- Codex command
44+
- commit comment
45+
- what Playwright is testing
46+
- what the user should test manually
47+
- ChatGPT does NOT:
48+
- create ZIP files
49+
- reference ZIP delivery
50+
- produce PLAN/BUILD/APPLY docs
2251
- Codex: creates plans, PR docs, ZIP bundles, and implementation code
2352
- User: runs Codex + validates
2453

2554
Output rules:
26-
- Always produce repo-structured ZIPs
27-
- Place ZIPs under <project folder>/tmp/
28-
- Preserve exact repo structure inside ZIP
55+
- ChatGPT MUST output ONLY:
56+
1. Codex command
57+
2. Commit comment
58+
3. What Playwright is testing
59+
4. What to test manually
60+
61+
## PLAYWRIGHT VALIDATION REQUIREMENT
62+
63+
Every PR must include:
64+
- What Playwright validates
65+
- Expected pass/fail behavior
66+
67+
## MANUAL TEST REQUIREMENT
68+
69+
Every PR must include:
70+
- exact manual validation steps
71+
- expected outcome
2972

3073
## 🔥 RESPONSE RULES (MANDATORY)
3174

@@ -168,9 +211,9 @@ If ZIP delivery fails more than once:
168211
- All PRs numbe improve the roadmap [ ] to [.] or [.] to [x]
169212
- If a PR is doc-only, bundle with next smallest executable/testable change
170213

171-
### ZIP IS ALWAYS REQUIRED
172-
- Never ask if a ZIP is needed
173-
- Always produce a ZIP
214+
### ZIP CREATION OWNERSHIP
215+
- ZIP creation is handled by Codex only.
216+
- ChatGPT must not create or reference ZIP delivery.
174217

175218
### DEFAULT EXECUTION MODE
176219
- Assume approval

docs/dev/codex_commands.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,3 +271,10 @@ PR_11_327
271271
```bash
272272
npx @openai/codex run --model gpt-5.3-codex --reasoning medium "Implement PR_11_327: fix the next failing tool from tool_completion_audit.md with a minimal single-tool change and required Workspace V2 Playwright gate validation."
273273
```
274+
275+
---
276+
PR_26123_001-project-instructions-update
277+
278+
```bash
279+
npx @openai/codex run --model gpt-5.3-codex --reasoning medium "Implement PROJECT_INSTRUCTIONS update: add PR naming standard, update ChatGPT output contract (command + commit comment + Playwright coverage + manual test steps), and enforce ChatGPT non-ZIP ownership language while keeping Codex ZIP ownership intact."
280+
```

docs/dev/commit_comment.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Align Palette Manager V2 launch label mapping with asset-manager-v2 contract name (Asset Manager V2) - PR 11.327
1+
Add PR naming standard and tighten ChatGPT output contract (command, commit, Playwright coverage, manual tests) with Codex-only ZIP ownership - PR_26123_001-project-instructions-update
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# PR_26123_001-project-instructions-update Report
2+
3+
## Scope
4+
- Targeted documentation-only update.
5+
- Updated ChatGPT contract wording and PR naming guidance in `docs/dev/PROJECT_INSTRUCTIONS.md`.
6+
- No runtime, schema, or tool behavior changes.
7+
8+
## Files Changed
9+
- `docs/dev/PROJECT_INSTRUCTIONS.md`
10+
- `docs/dev/codex_commands.md`
11+
- `docs/dev/commit_comment.txt`
12+
- `docs/dev/reports/PR_26123_001_project_instructions_update_report.md`
13+
14+
## Requested Contract Updates Applied
15+
- Added `PR NAMING STANDARD` section with format:
16+
- `PR_<YYJJJ>_<###>-<short-description>`
17+
- Replaced `Responsibilities` section with ChatGPT output responsibilities and non-responsibilities.
18+
- Replaced `Output rules` section with strict 4-item ChatGPT output contract.
19+
- Added `PLAYWRIGHT VALIDATION REQUIREMENT` section.
20+
- Added `MANUAL TEST REQUIREMENT` section.
21+
- Replaced `ZIP IS ALWAYS REQUIRED` section language with:
22+
- Codex-only ZIP creation ownership
23+
- ChatGPT must not create or reference ZIP delivery
24+
25+
## Validation
26+
- Manual content validation completed via direct file inspection and targeted string checks.
27+
- Verified roadmap guard sections remained present and unchanged in intent.
28+
- Full samples smoke test not run (docs-only change; no runtime impact).

0 commit comments

Comments
 (0)