143 lines
4.2 KiB
Markdown
143 lines
4.2 KiB
Markdown
# Project Initialization Implementation Plan
|
|
|
|
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
|
|
|
**Goal:** Initialize The Mindscape of Bro Tsong as a file-first cognitive model library MVP repository.
|
|
|
|
**Architecture:** The repository root is the product boundary. `model_library_mvp` is recorded as the current phase rather than implemented as a nested directory. The first commit creates documentation, rules, directory purpose files, and a concrete handoff without implementing model extraction.
|
|
|
|
**Tech Stack:** Markdown, JSON-ready folder structure, Git.
|
|
|
|
---
|
|
|
|
### Task 1: Create Root Documentation
|
|
|
|
**Files:**
|
|
|
|
- Create: `README.md`
|
|
- Create: `AGENTS.md`
|
|
|
|
- [x] **Step 1: Write project README**
|
|
|
|
Create `README.md` with project definition, phase name, first sample models, non-goals, repository structure, validation expectations, and next steps.
|
|
|
|
- [x] **Step 2: Write Codex working rules**
|
|
|
|
Create `AGENTS.md` with role boundaries, non-goals, data rules, source traceability rules, regression expectations, selector expectations, validation expectations, and handoff requirements.
|
|
|
|
### Task 2: Create Rule Documents
|
|
|
|
**Files:**
|
|
|
|
- Create: `docs/PROJECT_BRIEF.md`
|
|
- Create: `docs/DATA_CONTRACT.md`
|
|
- Create: `docs/WORKFLOW.md`
|
|
- Create: `docs/DECISIONS.md`
|
|
- Create: `docs/NON_GOALS.md`
|
|
- Create: `docs/HANDOFF_TEMPLATE.md`
|
|
|
|
- [x] **Step 1: Create project brief**
|
|
|
|
Document product context, first user, core need, MVP focus, long-term direction, and related project boundaries.
|
|
|
|
- [x] **Step 2: Create data contract**
|
|
|
|
Document JSON and Markdown responsibilities plus required fields for model specs, source articles, source excerpts, and regression cases.
|
|
|
|
- [x] **Step 3: Create workflow rules**
|
|
|
|
Document model extraction, development, model addition, stabilization, and handoff workflows.
|
|
|
|
- [x] **Step 4: Create decision log**
|
|
|
|
Record accepted structural decisions, including file-first architecture, JSON, Markdown, first sample models, rule-based selector, and flattened repository layout.
|
|
|
|
- [x] **Step 5: Create non-goals and handoff template**
|
|
|
|
Document v0.1 exclusions and a reusable handoff template.
|
|
|
|
### Task 3: Create Folder Purpose Files
|
|
|
|
**Files:**
|
|
|
|
- Create: `schemas/README.md`
|
|
- Create: `models/README.md`
|
|
- Create: `cards/README.md`
|
|
- Create: `sources/README.md`
|
|
- Create: `tests/README.md`
|
|
- Create: `selector/README.md`
|
|
- Create: `scripts/README.md`
|
|
- Create: `reports/README.md`
|
|
|
|
- [x] **Step 1: Create folder READMEs**
|
|
|
|
Create one README per initial folder so Git tracks the intended structure without adding empty placeholder data files.
|
|
|
|
### Task 4: Create Session Handoff
|
|
|
|
**Files:**
|
|
|
|
- Create: `reports/Codex_工程产物摘要_v0.1.md`
|
|
|
|
- [x] **Step 1: Write concrete session handoff**
|
|
|
|
Record completed work, created files, validation status, assumptions, deviations, known issues, product questions, and suggested next tasks.
|
|
|
|
### Task 5: Publish Initialization
|
|
|
|
**Files:**
|
|
|
|
- Git metadata only
|
|
|
|
- [ ] **Step 1: Initialize Git repository**
|
|
|
|
Run: `git init`
|
|
|
|
Expected: repository initialized in the current project root.
|
|
|
|
- [ ] **Step 2: Set default branch to main**
|
|
|
|
Run: `git branch -M main`
|
|
|
|
Expected: current branch is `main`.
|
|
|
|
- [ ] **Step 3: Add remote**
|
|
|
|
Run: `git remote add origin https://git.wantsong.life/wantsong/the-mindscape-of-bro-tsong.git`
|
|
|
|
Expected: `origin` points to the project remote.
|
|
|
|
- [ ] **Step 4: Verify structure**
|
|
|
|
Run: path checks for root files, docs files, and folder README files.
|
|
|
|
Expected: all expected files exist.
|
|
|
|
- [ ] **Step 5: Commit initialization**
|
|
|
|
Run:
|
|
|
|
```text
|
|
git add README.md AGENTS.md docs schemas models cards sources tests selector scripts reports
|
|
git commit -m "chore: initialize model library mvp"
|
|
```
|
|
|
|
Expected: a root commit containing the initialization files.
|
|
|
|
- [ ] **Step 6: Tag initialization**
|
|
|
|
Run: `git tag model-library-mvp-init-v0.1`
|
|
|
|
Expected: local tag created on the initialization commit.
|
|
|
|
- [ ] **Step 7: Push branch and tag**
|
|
|
|
Run:
|
|
|
|
```text
|
|
git push -u origin main
|
|
git push origin model-library-mvp-init-v0.1
|
|
```
|
|
|
|
Expected: branch and tag are available on the remote repository.
|