Skip to content

Commit 0345501

Browse files
ToolboxAidToolboxAid
committed
PR_26172_MASTER_001 project instructions readme and root
1 parent 0ccaf0e commit 0345501

12 files changed

Lines changed: 136 additions & 138 deletions

‎docs_build/dev/ProjectInstructions/PROJECT_INSTRUCTIONS.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Project Instructions Operating System
2+
3+
Read `README.txt` first.
4+
5+
This file is the root index for the append-first Project Instructions operating system under `docs_build/dev/ProjectInstructions/`.
6+
7+
## Purpose
8+
9+
The Project Instructions operating system provides additive governance for:
10+
11+
- backlog ownership
12+
- team assignments
13+
- multi-team branch and scope rules
14+
- Build Path status synchronization
15+
- tile overlay status behavior
16+
- deprecation workflow
17+
- archive and history preservation
18+
19+
## Preservation
20+
21+
Existing Project Instructions remain preserved in their current locations. This operating system adds structure without deleting or rewriting existing documentation.
22+
23+
## Folders
24+
25+
- `addendums/` contains additive governance rules.
26+
- `backlog/` contains the master backlog.
27+
- `team_assignments/` contains current team assignment records.
28+
- `deprecation/` contains deprecation workflow documentation.
29+
- `archive/` contains retained reference material.
30+
- `archive/history/` contains timestamped history snapshots.
31+
32+
## Merge Control
33+
34+
No PR in this operating system is merged without explicit owner approval.

‎docs_build/dev/ProjectInstructions/README.txt‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Read this file first.
2+
3+
Folder purpose:
4+
This folder is the append-first Project Instructions operating system for Game Foundry Studio. It organizes active governance, backlog, team assignment, deprecation, and history material without deleting or rewriting the existing Project Instructions files elsewhere in the repository.
5+
6+
Preservation rules:
7+
Preserve all existing documentation. Add new files or append explicit references unless the owner explicitly approves deletion or rewrite. When a conflict appears, stop, explain the conflict, and request owner approval before changing existing instruction text.
8+
9+
Backlog workflow:
10+
Backlog work is tracked under backlog/. BACKLOG_MASTER.md is the planned source for backlog item status, notes, and references. Backlog item text is treated as immutable once created; status and notes may change under the governance addendums.
11+
12+
Team assignment workflow:
13+
Team assignments are tracked under team_assignments/. A team pulls work from BACKLOG_MASTER.md, marks the item building when assigned, and records the active assignment under the owning team. Teams work only on assigned items unless a MASTER override explicitly changes the assignment.
14+
15+
No direct commits to main:
16+
Do not commit directly to main unless the owner explicitly instructs that exception. Normal work must use PR branches, draft PRs, validation evidence, and owner-controlled merge approval.
17+
18+
MASTER override rule:
19+
A MASTER override must use this wording:
20+
MASTER override approved: <reason>
21+
22+
The override must explain why normal team, branch, assignment, or backlog routing is being changed.
23+
24+
History snapshot rule:
25+
When a governance or instruction state needs a history snapshot, add a new file under archive/history/ using:
26+
CCYYMMDD_HHMMSS.md
27+
28+
Do not rewrite history snapshots after creation unless the owner explicitly approves.

‎docs_build/dev/ProjectInstructions/addendums/.gitkeep‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Tracked placeholder for Project Instructions addendums.

‎docs_build/dev/ProjectInstructions/archive/history/.gitkeep‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Tracked placeholder for Project Instructions history snapshots.

‎docs_build/dev/ProjectInstructions/backlog/.gitkeep‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Tracked placeholder for Project Instructions backlog.

‎docs_build/dev/ProjectInstructions/deprecation/.gitkeep‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Tracked placeholder for Project Instructions deprecation workflow.

‎docs_build/dev/ProjectInstructions/team_assignments/.gitkeep‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Tracked placeholder for Project Instructions team assignments.

‎docs_build/dev/reports/PR_26172_MASTER_001-project-instructions-readme-and-root-instruction-compliance-checklist.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# PR_26172_MASTER_001 Instruction Compliance Checklist
2+
3+
- PASS: Read `docs_build/dev/PROJECT_INSTRUCTIONS.md`.
4+
- PASS: Read `docs_build/dev/PROJECT_MULTI_PC.txt`.
5+
- PASS: Explicit MASTER override accepted Team MASTER for this operating-system bootstrap.
6+
- PASS: Branch name mirrors PR ownership: `pr/26172-MASTER-001-project-instructions-readme-and-root`.
7+
- PASS: Implementation path is `docs_build/dev/ProjectInstructions/`.
8+
- PASS: Existing Project Instructions were preserved.
9+
- PASS: No direct commit to `main`.
10+
- PASS: Required review artifacts are produced.
11+
- PASS: Required ZIP path is `tmp/PR_26172_MASTER_001-project-instructions-readme-and-root_delta.zip`.

‎docs_build/dev/reports/PR_26172_MASTER_001-project-instructions-readme-and-root-manual-validation-notes.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# PR_26172_MASTER_001 Manual Validation Notes
2+
3+
- Confirmed branch was created from latest `main`.
4+
- Confirmed only new files were added.
5+
- Confirmed existing Project Instructions files were not deleted or rewritten.
6+
- Confirmed `README.txt` includes every requested topic.
7+
- Confirmed placeholders are used only to track requested empty folders.
8+
- Did not run Playwright because this is documentation-only.
9+
- Did not run samples.

‎docs_build/dev/reports/PR_26172_MASTER_001-project-instructions-readme-and-root.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# PR_26172_MASTER_001-project-instructions-readme-and-root
2+
3+
## Scope
4+
5+
Create the Project Instructions operating system root under `docs_build/dev/ProjectInstructions/`.
6+
7+
## Changes
8+
9+
- Added root `README.txt` with first-read guidance, preservation rules, backlog workflow, team assignment workflow, direct-main restriction, MASTER override wording, and history snapshot rule.
10+
- Added root `PROJECT_INSTRUCTIONS.md` as the operating system index.
11+
- Added tracked placeholders for requested folders so Git carries the directory structure.
12+
13+
## Validation
14+
15+
- `git diff --check`
16+
- Markdown/text review for requested README topics.
17+
- Playwright skipped: no runtime UI files changed.
18+
- Samples skipped: not requested and no sample files changed.
19+
20+
## ZIP
21+
22+
`tmp/PR_26172_MASTER_001-project-instructions-readme-and-root_delta.zip`

0 commit comments

Comments
 (0)