docs: plan phase1 structure alignment refactor
This commit is contained in:
@@ -0,0 +1,70 @@
|
||||
# Sprint Contract: Architecture Evaluator Closeout
|
||||
|
||||
## Objective
|
||||
Independently evaluate the completed structure-alignment refactor against `docs/ARCHITECTURE.md`, persistent project guardrails, tests, reference artifacts, and phase handoff requirements.
|
||||
|
||||
## Required Reading
|
||||
- /AGENTS.md
|
||||
- /PROGRESS.md
|
||||
- /PLAN.md
|
||||
- /docs/README.md
|
||||
- /docs/HARNESS_ENGINEERING.md
|
||||
- /docs/ARCHITECTURE.md
|
||||
- /docs/ADR.md
|
||||
- /docs/NUMERICAL_CONVENTIONS.md
|
||||
- /docs/ABAQUS_INPUT_SUBSET.md
|
||||
- /docs/VERIFICATION_PLAN.md
|
||||
- /docs/RESULTS_SCHEMA.md
|
||||
- /docs/MITC4_FORMULATION.md
|
||||
- /phases/1-structure-alignment-refactor/index.json
|
||||
- /phases/1-structure-alignment-refactor/step0-architecture-map.md
|
||||
|
||||
## Scope
|
||||
- Review the final production layout under `include/fesa/` and `src/`.
|
||||
- Confirm the umbrella header is a facade, not the primary implementation body.
|
||||
- Confirm source ownership matches the `src/` directory structure in `docs/ARCHITECTURE.md`.
|
||||
- Run validation and inspect stored-reference regression status.
|
||||
- Produce an evaluator report at `phases/1-structure-alignment-refactor/step9-evaluator-report.md`.
|
||||
- Update phase status, `PLAN.md`, and `PROGRESS.md`.
|
||||
|
||||
## Allowed Files
|
||||
- `phases/index.json`
|
||||
- `phases/1-structure-alignment-refactor/index.json`
|
||||
- `phases/1-structure-alignment-refactor/step9-evaluator-report.md`
|
||||
- `PLAN.md`
|
||||
- `PROGRESS.md`
|
||||
|
||||
## Explicit Non-Goals
|
||||
- Do not implement missing refactor work in the evaluator step.
|
||||
- Do not change solver behavior or tests to make evaluation pass.
|
||||
- Do not claim full PRD Phase 1 completion unless R-010 and R-013 are also resolved.
|
||||
- Do not approve a layout that still relies on `fesa.hpp` as the main implementation location.
|
||||
|
||||
## Tests To Write First
|
||||
- None. This is an evaluator-only step.
|
||||
|
||||
## Reference Artifacts
|
||||
- `references/quad_02_phase1.inp`
|
||||
- `references/quad_02_displacements.csv`
|
||||
|
||||
## Acceptance Commands
|
||||
```bash
|
||||
python scripts/validate_workspace.py
|
||||
```
|
||||
|
||||
## Evaluator Checklist
|
||||
- `src/Analysis`, `src/Assembly`, `src/Boundary`, `src/Core`, `src/Element`, `src/IO`, `src/Load`, `src/Math`, `src/Material`, `src/Property`, `src/Results`, and `src/Util` exist as needed and own their documented implementation areas.
|
||||
- `include/fesa/fesa.hpp` is a compatibility facade and does not contain the bulk of production implementation.
|
||||
- Public tests and direct module include tests pass.
|
||||
- Parser subset, MITC4 formulation, numerical conventions, result schema, and reference comparison behavior are unchanged.
|
||||
- `quad_02_phase1` stored displacement regression still passes.
|
||||
- PLAN/PROGRESS clearly state any residual architecture debt.
|
||||
|
||||
## Handoff Requirements
|
||||
- If passed, mark `1-structure-alignment-refactor` completed in `phases/index.json`.
|
||||
- If failed, write concrete findings and required fixes in `step9-evaluator-report.md` and keep the phase pending or blocked.
|
||||
- Keep R-010 and R-013 visible if they remain unresolved.
|
||||
|
||||
## Do Not
|
||||
- Do not self-approve incomplete module separation.
|
||||
- Do not let a passing compile hide architecture drift.
|
||||
Reference in New Issue
Block a user