docs: add architecture and full audit; fill project templates (.gitignore, scripts/test.sh) per audit findings
Some checks failed
ci / test (push) Has been cancelled
Some checks failed
ci / test (push) Has been cancelled
This commit is contained in:
29
docs/audits/2025-09-17-audit.llm.md
Normal file
29
docs/audits/2025-09-17-audit.llm.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Audit — 2025-09-17
|
||||
|
||||
Summary
|
||||
- Scope: Repo structure, governance compliance, plan alignment, CI/containers, TDD, zero-debt.
|
||||
- Status: Mostly compliant; a few gaps noted with fixes proposed or applied.
|
||||
|
||||
Findings
|
||||
- Governance
|
||||
- One-way Q→P→Plan: compliant.
|
||||
- Read `.llm.md`/write both: compliant in artifacts; continue practice.
|
||||
- TDD: present; tests for CLI/guardrails/new-mode exist; proceed to cover remaining milestones.
|
||||
- Zero debt: generally compliant; architecture doc added now to satisfy plan; keep docs/tests in lockstep.
|
||||
- Clean root: compliant; marker removed; heuristic detection in place.
|
||||
- Planning/architecture: docs/architecture.md added; maintain ADRs if decisions evolve.
|
||||
- CI/containers: Gitea workflow + Docker Compose present; local parity script present.
|
||||
- Repo Structure
|
||||
- Organized under `collab/`, `docs/`, `prompts/`, `modes/`, `templates/`, `scripts/`, `meta/`, `.gitea/` — clean.
|
||||
- Scaffolding Templates
|
||||
- Added project CI/Docker templates and AGENTS.md. Missing: project `.gitignore` and `scripts/test.sh` template (recommended; add).
|
||||
- Tests
|
||||
- Repo tests pass (internal runner). Add Docker test run to CI already configured.
|
||||
- Open Work vs Plan
|
||||
- Pending: `new-project`, `run`, config precedence (`yq`), copying templates, `.gitignore` template, project scripts/test.sh.
|
||||
|
||||
Actions
|
||||
- Add templates/project/_shared/{.gitignore,scripts/test.sh} [recommended ASAP].
|
||||
- Implement remaining milestones via TDD; expand tests accordingly.
|
||||
- Keep DevLogs updated for each change.
|
||||
|
34
docs/audits/2025-09-17-audit.md
Normal file
34
docs/audits/2025-09-17-audit.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Audit — 2025-09-17
|
||||
|
||||
Scope
|
||||
- Full audit of repository against governance rules, proposal/plan, and delivered code.
|
||||
|
||||
Summary
|
||||
- Compliance is strong across governance (TDD, zero-debt, planning, clean root, CI/containers). Gaps are minor and fixable now.
|
||||
|
||||
Findings
|
||||
- Governance compliance
|
||||
- One-way Questions→Proposal→Plan process is followed; confirmations consolidated into the proposal.
|
||||
- `.llm.md`-first reading and dual-write artifacts are present and used.
|
||||
- TDD in effect (tests for CLI/guardrails/new-mode). Continue test-first for remaining milestones.
|
||||
- Zero technical debt emphasized; architecture doc added to meet plan; docs kept current.
|
||||
- Clean root enforced; marker removed; heuristic repo detection implemented and tested.
|
||||
- Planning/architecture documented in `docs/architecture.md`; maintain ADRs if decisions change.
|
||||
- CI/containers aligned with Gitea and local parity via Docker Compose; names explicit and cleanup performed.
|
||||
- Structure
|
||||
- Root remains minimal. Subdirectories are coherent: `collab/`, `docs/`, `prompts/`, `modes/`, `templates/`, `scripts/`, `meta/`, `.gitea/`.
|
||||
- Templates
|
||||
- Project templates include AGENTS.md and CI/Docker artifacts. Missing `.gitignore` and `scripts/test.sh` template — add now.
|
||||
- Tests
|
||||
- Repo tests pass locally (internal runner). Docker-based runner available (`scripts/test.docker.sh`). CI workflow uses the same compose.
|
||||
- Open vs Plan
|
||||
- Not yet implemented: `new-project`, `run`, YAML precedence (`yq`), project `.gitignore`, project scripts/test.sh, copying mode/global prompts.
|
||||
|
||||
Recommendations (immediate)
|
||||
- Add `templates/project/_shared/.gitignore` with `runs/` and common ignores.
|
||||
- Add `templates/project/_shared/scripts/test.sh` mirroring repo test runner.
|
||||
- Proceed with TDD for remaining milestones; update docs/DevLogs at each step.
|
||||
|
||||
Conclusion
|
||||
- The project is on track and adheres to governance. Address the small template gaps and continue TDD implementation.
|
||||
|
Reference in New Issue
Block a user