Skip to content

Commit 83aaabc

Browse files
committed
Clarify tracked report governance
1 parent 994b844 commit 83aaabc

15 files changed

Lines changed: 196 additions & 3 deletions

dev/build/ProjectInstructions/addendums/codex_artifact_and_reporting_standard.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,20 @@ Optional:
9797

9898
Generated non-report artifacts must live under `dev/workspace/`.
9999

100+
## Tracked Report Governance
101+
102+
`dev/reports/` is an authoritative repository report location and is tracked by Git.
103+
104+
Rules:
105+
106+
- Any changes to `dev/reports/` generated during a PR are expected to be included in that PR.
107+
- A clean `main` means the latest report files have been committed and merged.
108+
- Do not delete report files only to make the worktree clean.
109+
- Do not add `dev/reports/` to `.gitignore`.
110+
- Do not move reports outside the repository.
111+
- Continue using `dev/reports/` for reports and `dev/workspace/zips/` for ZIPs.
112+
- Generated post-merge closeout reports should either be committed in a follow-up governance/report PR or avoided on `main` when no commit is intended.
113+
100114
## Completion Reporting
101115

102116
Codex responses must include:

dev/build/ProjectInstructions/addendums/pr_workflow.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Closed gates:
105105
- PR merged and changes pushed.
106106
- Current branch is `main`.
107107
- `main` includes the merge commit or recorded final commit.
108-
- Worktree clean.
108+
- Worktree clean, including tracked `dev/reports/` updates committed and merged.
109109
- Local/origin sync is `0/0`.
110110
- No untracked files.
111111
- Branch disposition is recorded as `retained`.
@@ -132,6 +132,7 @@ Closed gates:
132132
- If OWNER decision is required, stop and report.
133133
- Every PR lifecycle state must satisfy the Codex Completion Contract when Codex executes work for that state.
134134
- ZIP artifacts belong under `dev/workspace/zips/` and must not replace required reports under `dev/reports/`.
135+
- Generated reports under `dev/reports/` are tracked source for the PR. Do not delete report files only to make the worktree clean, do not ignore `dev/reports/`, and do not move reports outside the repository.
135136
- Stacked PR chains produce one final outcome ZIP per attempted PR and stop before later PRs after failure or hard stop.
136137

137138
## Batch Governance Mode

dev/build/ProjectInstructions/repository/canonical_repository_structure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Dev workspace ownership:
6262
- dev/archive/ owns historical reference material only.
6363
- dev/build/ owns active Project Instructions, architecture, database DDL/DML/seed docs, standards, backlog, PR planning, and governance.
6464
- dev/config/ owns development-only runner and tooling configuration.
65-
- dev/reports/ owns active and historical generated reports.
65+
- dev/reports/ owns active and historical generated reports. Report files under `dev/reports/` are authoritative tracked repository source and must not be deleted only to make the worktree clean.
6666
- dev/scripts/ owns development-only scripts and runners.
6767
- dev/templates/ owns reusable development templates.
6868
- dev/tests/ owns non-deployable test suites.
@@ -110,7 +110,7 @@ These legacy transition buckets may remain until explicit migration PRs move the
110110
- New development follows the canonical structure.
111111
- New deployable `src/` work follows `src/web/`, `src/api-runtime/`, or `src/runtime/`.
112112
- New non-deployable work belongs under `dev/`.
113-
- Required reports belong under flat `dev/reports/`.
113+
- Required reports belong under flat tracked `dev/reports/`.
114114
- Required ZIPs belong under `dev/workspace/zips/`; generated temporary artifacts belong under `dev/workspace/tmp/`.
115115

116116
## Creator Data Boundary
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# PR277 Post-Merge Branch Validation
2+
3+
Status: PASS
4+
5+
- Current branch is `main`: PASS
6+
- HEAD is `994b844cb6f5ddae29239962a751da997e207d9e`: PASS
7+
- `main...origin/main` is `0 0`: PASS
8+
- Worktree was clean before closeout report generation: PASS
9+
- No code changes were made: PASS
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# PR277 Post-Merge Manual Validation Notes
2+
3+
Manual validation status: READY
4+
5+
This closeout package is documentation/artifact only. No code, runtime behavior, database schema, or DEV identity data changed during this packaging step.
6+
7+
Manual review:
8+
9+
- Confirm PR #277 is merged in GitHub.
10+
- Confirm local `main` remains on merge commit `994b844cb6f5ddae29239962a751da997e207d9e`.
11+
- Confirm the closeout ZIP exists under `dev/workspace/zips/`.
12+
- DEV identity sync was intentionally not run in this packaging step.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# PR277 Post-Merge Closeout
2+
3+
## Summary
4+
5+
Post-merge closeout package for GitHub PR #277, `PR_26179_OWNER_035-dev-auth-user-key-db-authority`.
6+
7+
No runtime code, database code, tests, product UI, or DEV identity data was changed during this packaging step.
8+
9+
## Repository Gate
10+
11+
- Branch: `main`
12+
- HEAD: `994b844cb6f5ddae29239962a751da997e207d9e`
13+
- `main...origin/main`: `0 0`
14+
- Worktree before packaging: clean
15+
- PR #277 merged: yes
16+
- Merge commit: `994b844cb6f5ddae29239962a751da997e207d9e`
17+
18+
## Validation
19+
20+
- `git diff --check`: PASS
21+
- `npm run validate:canonical-structure`: PASS
22+
23+
## Notes
24+
25+
DEV identity sync was not run in this packaging step.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# PR277 Post-Merge Requirement Checklist
2+
3+
Status: PASS
4+
5+
- Confirm branch is `main`: PASS
6+
- Confirm HEAD is `994b844cb6f5ddae29239962a751da997e207d9e`: PASS
7+
- Confirm `main...origin/main = 0 0`: PASS
8+
- Confirm worktree clean before packaging: PASS
9+
- Run `git diff --check`: PASS
10+
- Run `npm run validate:canonical-structure`: PASS
11+
- Create reports under `dev/reports/`: PASS
12+
- Create repo-structured ZIP under `dev/workspace/zips/`: PASS
13+
- Do not change code: PASS
14+
- Do not run DEV identity sync: PASS
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# PR277 Post-Merge Validation Report
2+
3+
Status: PASS
4+
5+
## Commands
6+
7+
```text
8+
git diff --check
9+
```
10+
11+
Result: PASS
12+
13+
```text
14+
npm run validate:canonical-structure
15+
```
16+
17+
Result: PASS
18+
19+
Output summary:
20+
21+
```text
22+
Canonical repository structure guardrail: PASS
23+
Blocking violations: 0
24+
Approved legacy exceptions: 500
25+
```
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# PR_26179_OWNER_036-reports-are-tracked-source Branch Validation
2+
3+
Status: PASS
4+
5+
- Source branch: `PR_26179_OWNER_036-reports-are-tracked-source`
6+
- Base branch: `main`
7+
- Branch created from synchronized `main`: PASS
8+
- Existing generated report artifacts preserved: PASS
9+
- Scope limited to governance docs and reports: PASS
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# PR_26179_OWNER_036-reports-are-tracked-source Manual Validation Notes
2+
3+
Manual validation status: READY
4+
5+
Review the governance wording in:
6+
7+
- `dev/build/ProjectInstructions/addendums/codex_artifact_and_reporting_standard.md`
8+
- `dev/build/ProjectInstructions/repository/canonical_repository_structure.md`
9+
- `dev/build/ProjectInstructions/addendums/pr_workflow.md`
10+
11+
Confirm the policy says tracked report files are expected PR source, and that post-merge closeout reports should be committed in a follow-up governance/report PR or avoided on `main` when no commit is intended.

0 commit comments

Comments
 (0)