archieve codebase curation (spit to smaller tracks)
This commit is contained in:
@@ -1,26 +0,0 @@
|
||||
# Granular Review Protocol: Codebase Curation
|
||||
|
||||
This protocol defines the mandatory procedure for auditing and modifying files during the Phase 5 Heavy Curation. It is designed to minimize entropy and prevent regression propagation.
|
||||
|
||||
## 1. File-by-File Audit Cycle
|
||||
|
||||
For every `.py` file identified for curation:
|
||||
|
||||
1. **Dependency Check:** Use `derive_code_path` and `py_get_imports` to identify all upstream and downstream dependencies.
|
||||
2. **State Verification:** Consult the `MUTATION_MATRIX_PHASE5.md` to identify any global state modifications performed by the file.
|
||||
3. **Redundancy Identification:** Cross-reference the file against `CULLING_CANDIDATES_PHASE5.md`.
|
||||
4. **Proposed Change Log:** Before editing, document the specific lines/symbols to be removed or refactored and the technical justification (e.g., "Superseded by theme_2.py").
|
||||
5. **Surgical Edit:** Use the `replace` tool for targeted deletions. Avoid bulk file overwrites.
|
||||
6. **Style Verification:** Immediately run `scripts/ai_style_formatter.py` on the modified file to ensure indentation and formatting standards are maintained.
|
||||
|
||||
## 2. Regression Guardrails
|
||||
|
||||
- **Functional Parity:** After every major deletion (e.g., removing a redundant module), run the associated unit tests (if any).
|
||||
- **Simulation Verification:** For changes to core pipelines (AI loop, Aggregation), run at least one relevant simulation (e.g., `simulation/ping_pong.py`) to verify end-to-end behavior.
|
||||
- **Human-in-the-Loop:** Significant refactors (e.g., the `aggregate.py` rework) MUST be presented to the user with a detailed diff before final commitment.
|
||||
|
||||
## 3. Culling Justification Standards
|
||||
|
||||
- **"Unused"**: Symbol has 0 project-wide references in the audit.
|
||||
- **"Redundant"**: Logic exists in a superior or more modern form elsewhere (e.g., `theme.py`).
|
||||
- **"Slop"**: Code that adds complexity without contributing to performance, configuration, or a specified feature.
|
||||
@@ -1,5 +0,0 @@
|
||||
# Track codebase_curation_20260507 Context
|
||||
|
||||
- [Specification](./spec.md)
|
||||
- [Implementation Plan](./plan.md)
|
||||
- [Metadata](./metadata.json)
|
||||
@@ -1,8 +0,0 @@
|
||||
{
|
||||
"track_id": "codebase_curation_20260507",
|
||||
"type": "chore",
|
||||
"status": "new",
|
||||
"created_at": "2026-05-07T15:00:00Z",
|
||||
"updated_at": "2026-05-07T15:00:00Z",
|
||||
"description": "Exhaustive review of all .py files. Remove redundancies, eliminate unnecessary code/data/processing, and strictly align with project standards."
|
||||
}
|
||||
@@ -1,29 +0,0 @@
|
||||
# Implementation Plan: Comprehensive Codebase Curation & Style Alignment (codebase_curation_20260507)
|
||||
|
||||
## Phase 0: Context Integration & Strategy
|
||||
- [x] Task: Review all Phase 5 analysis reports in `./docs` to internalize the curation roadmap.
|
||||
- [x] Task: Define a "Granular Review Protocol" for file-by-file auditing and culling.
|
||||
- [x] Task: Conductor - User Manual Verification 'Curation Strategy' (Protocol in workflow.md)
|
||||
|
||||
## Phase 1: Automated Standardization & Audit
|
||||
- [~] Task: Run `scripts/ai_style_formatter.py` and `scripts/force_1space.py` on all files in `./src` and `./simulation`.
|
||||
- [ ] Task: Conduct an automated entropy audit to identify potential redundancy "hotspots".
|
||||
- [ ] Task: Conductor - User Manual Verification 'Standardization' (Protocol in workflow.md)
|
||||
|
||||
## Phase 2: Surgical Curation of `./src`
|
||||
- [ ] Task: Comprehensive rework of `src/aggregate.py`. Modernize context assembly to leverage MCP tools, snapshots, and file caching. Consolidate tier-specific boilerplate.
|
||||
- [ ] Task: Review and trim `gui_2.py` and `app_controller.py` based on pipeline maps.
|
||||
- [ ] Task: Consolidate data models in `models.py` and remove redundant state in `aggregate.py`.
|
||||
- [ ] Task: Refactor `ai_client.py` to ensure lean processing of provider responses.
|
||||
- [ ] Task: Conductor - User Manual Verification 'Source Curation' (Protocol in workflow.md)
|
||||
|
||||
## Phase 3: Surgical Curation of `./simulation`
|
||||
- [ ] Task: Review and trim `./simulation/` base classes and utility scripts.
|
||||
- [ ] Task: Eliminate redundant setup logic in `sim_context.py` and `workflow_sim.py`.
|
||||
- [ ] Task: Conductor - User Manual Verification 'Simulation Curation' (Protocol in workflow.md)
|
||||
|
||||
## Phase 4: Final Integrity Pass
|
||||
- [ ] Task: Verify all tests pass with the trimmed codebase.
|
||||
- [ ] Task: Final comparison against `product-guidelines.md` for architectural purity.
|
||||
- [ ] Task: Final performance baseline check to ensure no regressions.
|
||||
- [ ] Task: Conductor - User Manual Verification 'Final Review' (Protocol in workflow.md)
|
||||
@@ -1,35 +0,0 @@
|
||||
# Specification: Comprehensive Codebase Curation & Style Alignment (codebase_curation_20260507)
|
||||
|
||||
## Overview
|
||||
Aggressive pruning, optimization, and standardization of the codebase. This track uses the findings from the Code Path Analysis and other Phase 5 audits to trim away non-essential logic, data, and processing while strictly enforcing the project's technical integrity standards.
|
||||
|
||||
## Foundational Context (MANDATORY REVIEW)
|
||||
All curation efforts MUST be informed by the following Phase 5 analysis reports:
|
||||
- `docs/PIPELINE_ANALYSIS_PHASE5_INIT.md`: Processing route and pipeline mapping.
|
||||
- `docs/STATE_INVENTORY_PHASE5.md`: Core data structure and property inventory.
|
||||
- `docs/MUTATION_MATRIX_PHASE5.md`: Thread-safe state modification and lock map.
|
||||
- `docs/CULLING_CANDIDATES_PHASE5.md`: Identified redundant symbols, modules, and structures.
|
||||
|
||||
## Granular Care & Regression Guardrails
|
||||
- **Surgical Execution:** Changes must be applied file-by-file with extreme granularity. No bulk culling without individual justification.
|
||||
- **Regression Monitoring:** Continuous verification of behavioral integrity. Any unintended entropy or performance degradation must trigger an immediate halt and review.
|
||||
- **Traceability:** Every removed line must be cross-referenced against the culling audit or pipeline map.
|
||||
|
||||
## Scope
|
||||
- **Target Files:** All `.py` files in `./src` and `./simulation`.
|
||||
- **Primary Goal:** Trimming the "slop" (redundancies, dead code, excessive complexity).
|
||||
|
||||
## Functional Requirements
|
||||
1. **Redundancy Pruning:** Eliminate duplicate logic across different data pipelines.
|
||||
2. **Dead Code Removal:** Strip out legacy "just-in-case" code and unused processing paths.
|
||||
3. **Strict Style Enforcement:**
|
||||
- Universal 1-space indentation.
|
||||
- CRLF line endings.
|
||||
- Standardized type hinting.
|
||||
4. **Guideline Alignment:** Refactor any code that deviates from `product-guidelines.md` (e.g., ensuring explicit composition over complex inheritance).
|
||||
5. **Validation:** Ensure no loss of functionality or performance degradation.
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Significant reduction in total codebase line count (where applicable).
|
||||
- [ ] 100% pass on style audit (`scripts/ai_style_formatter.py`).
|
||||
- [ ] All remaining code is mapped to a necessary functional requirement or performance goal.
|
||||
Reference in New Issue
Block a user