KNEL/ChatGPTScaffolding
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

governance: add planning/architecture rule (plan ahead, module map, avoid refactors); propagate to system prompts, AGENTS templates, proposal, and plan

Browse Source
This commit is contained in:
Charles N Wyble - admin
2025-09-17 10:33:57 -05:00
parent fae0f5b413
commit c655476699
10 changed files with 47 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
collab/plan/01-codexhelper.md
View File

@@ -7,6 +7,10 @@ Purpose: Deliver Phase 1 (Crawl) MVP of CodexHelper: subcommands, scaffolding, p
- Add `tests/` directory and `scripts/test.sh` using bats-core (document installation/usage).
- Write initial smoke tests that will fail until implementation exists.
0a) Architecture & Module Map
- Create `docs/architecture.md` summarizing global architecture, module boundaries, and responsibilities for Phase 1.
- Add or update ADRs as needed for key decisions.
1) CLI skeleton + guardrails (tests first)
- Write tests for `--help`, subcommands, and location guardrails.
- Implement `CodexHelper` with `new-project`, `run`, `new-mode` and enforce location rules.
@@ -43,7 +47,8 @@ Purpose: Deliver Phase 1 (Crawl) MVP of CodexHelper: subcommands, scaffolding, p
- Minimal chat; read `.llm.md`, write both `.md` and `.llm.md` for collab artifacts.
- Governance/Propagation: reflect future non-project-specific norms into `prompts/global/` and AGENTS templates; log in DevLog.
- TDD default: write failing tests before implementing features; require unit/integration tests for all new functionality in this repo and generated projects.
- Zero Technical Debt: safety first; no technical debt; always production-ready; do not defer tests/docs/refactors; use sub-agents as needed to maintain quality and speed.
- Zero Technical Debt: safety first; no technical debt; always production-ready; do not defer tests/docs/refactors; use sub-agents as needed to maintain quality and speed.
- Planning/Architecture: align via Questions→Proposal→Plan; maintain `docs/architecture.md` and ADRs; avoid refactors except when plans/docs are updated due to new information.
## Acceptance Criteria
- Inside this repo: `CodexHelper new-mode --name Demo` creates `modes/Demo/{mode.md,defaults.yaml}` (and optional `system.md`) and refuses overwrites without `--force`.
@@ -62,6 +67,7 @@ Purpose: Deliver Phase 1 (Crawl) MVP of CodexHelper: subcommands, scaffolding, p
## Timeline (targeted)
Accelerated (8 hours today):
- Hour 0–1: Test harness setup; write failing smoke tests (CLI, guardrails)
- Hour 0–1 (parallel): Draft `docs/architecture.md` (module map) and commit
- Hour 1–2: Milestone 1 — CLI skeleton + guardrails (make tests pass)
- Hour 2–3: Milestone 2 — Binary detection + pass-through (tests first)
- Hour 3–4: Milestone 3 — new-mode scaffolder (tests first)