codeflash-ai/codeflash-internal
1
0
Fork 0
Code Issues Pull requests 39 Projects Releases Packages Wiki Activity Actions 2.0k

docs: define milestone v1.2 requirements

Browse source 
6 requirements across 3 categories (File Cleanup, Verification, Documentation)
This commit is contained in:
Kevin Turcios 2026-01-31 18:00:58 +00:00
parent 5f7e9f9a26
commit 9fdd2ff654
1 changed files with 45 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

96
.planning/REQUIREMENTS.md
View file

@ -1,47 +1,48 @@
# Requirements: Multi-Language Testgen Organization
**Defined:** 2026-01-30
**Defined:** 2026-01-31
**Core Value:** Clear, consistent structure that makes it trivial to understand how test generation requests flow through the system, where language-specific code lives, and how to add a new language without touching existing code.
## v1.1 Requirements: Testgen Module Consolidation
## v1.2 Requirements: Prompt Cleanup
Requirements for colocating all testgen-related code under `aiservice/testgen/` module.
Requirements for removing duplicate and orphaned prompt files to establish single source of truth.
### Directory Structure
### File Cleanup
- [x] **STRUCT-01**: Move `aiservice/languages/` directory to `aiservice/testgen/languages/`
### Import Path Updates
- [x] **IMPORT-01**: Update all absolute imports from `aiservice.languages.*` to `aiservice.testgen.languages.*` throughout codebase
- [x] **IMPORT-02**: Update entry point imports in `testgen/testgen.py` and `testgen/registry.py`
- [x] **IMPORT-03**: Update any relative imports within language modules affected by restructuring
### Test Updates
- [x] **TEST-01**: Update all test imports to use new `testgen.languages.*` paths
- [x] **TEST-02**: Update test fixtures and mocks that reference old directory structure
- [x] **TEST-03**: Verify all tests pass after migration (quality gate)
### Documentation
- [x] **DOCS-01**: Update developer guides (CONTRIBUTING.md or similar) with new import paths
- [x] **DOCS-02**: Update "How to Add a Language" guide with new directory structure
- [x] **DOCS-03**: Update architectural documentation referencing old structure
- [ ] **CLEAN-01**: Remove 7 duplicate Python prompts from testgen root (`execute_async_system_prompt.md`, `execute_async_user_prompt.md`, `execute_system_prompt.md`, `execute_user_prompt.md`, `explain_system_prompt.md`, `explain_user_prompt.md`, `jit_system_prompt.md`)
- [ ] **CLEAN-02**: Remove legacy `prompts/javascript/` directory containing 4 duplicate JavaScript prompt files
- [ ] **CLEAN-03**: Archive valuable content before deletion (`jit_system_prompt.md` with 11K of JIT testing guidance, `explain_*` prompts for code explanation feature)
### Verification
- [x] **VERIFY-01**: Confirm no lingering references to `aiservice.languages.*` imports remain
- [x] **VERIFY-02**: Confirm external API compatibility maintained (zero breaking changes)
- [ ] **VERIFY-01**: Confirm no code references deleted files (search codebase for imports or file reads)
- [ ] **VERIFY-02**: Run full test suite to confirm no broken imports or file-not-found errors
## v1.0 Requirements (Completed)
### Documentation
Shipped in v1.0 milestone (2026-01-30):
- [ ] **DOCS-01**: Document what was removed and why (create removal justification with list of 14 files, explain active prompt locations, note archived content)
## v1.0-v1.1 Requirements (Completed)
**v1.1 (Shipped 2026-01-31):**
- ✓ **STRUCT-01**: Move `aiservice/languages/` directory to `aiservice/testgen/languages/` — v1.1
- ✓ **IMPORT-01**: Update all absolute imports from `aiservice.languages.*` to `aiservice.testgen.languages.*` — v1.1
- ✓ **IMPORT-02**: Update entry point imports in `testgen/testgen.py` and `testgen/registry.py` — v1.1
- ✓ **IMPORT-03**: Update any relative imports within language modules — v1.1
- ✓ **TEST-01**: Update all test imports to use new `testgen.languages.*` paths — v1.1
- ✓ **TEST-02**: Update test fixtures and mocks that reference old directory structure — v1.1
- ✓ **TEST-03**: Verify all tests pass after migration (quality gate) — v1.1
- ✓ **DOCS-01-v1.1**: Update developer guides with new import paths — v1.1
- ✓ **DOCS-02-v1.1**: Update "How to Add a Language" guide with new directory structure — v1.1
- ✓ **DOCS-03-v1.1**: Update architectural documentation referencing old structure — v1.1
- ✓ **VERIFY-01-v1.1**: Confirm no lingering references to `aiservice.languages.*` imports — v1.1
- ✓ **VERIFY-02-v1.1**: Confirm external API compatibility maintained — v1.1
**v1.0 (Shipped 2026-01-30):**
- ✓ **ORG-01**: Define clear organizational structure for multi-language support — v1.0
- ✓ **ORG-02**: Establish consistent pattern for language handlers — v1.0
- ✓ **ORG-03**: Organize entry point and routing logic — v1.0
- ✓ **ORG-04**: Create clear separation of concerns (generation, preprocessing, instrumentation, postprocessing) — v1.0
- ✓ **ORG-04**: Create clear separation of concerns — v1.0
- ✓ **ORG-05**: Document structure and flow for developers — v1.0
- ✓ **ORG-06**: Enable easy addition of new languages following clear template — v1.0
- ✓ **ORG-07**: Enable modification of one language without affecting others — v1.0
@ -51,10 +52,11 @@ Shipped in v1.0 milestone (2026-01-30):
| Feature | Reason |
|---------|--------|
| Changing internal language directory structure | Moving as-is, not reorganizing within python/ or javascript/ |
| Adding new languages | Focus on consolidating existing structure first |
| Changing handler patterns or registry | v1.0 patterns are validated, just relocating |
| Frontend/API changes | Backend-only reorganization, API contract unchanged |
| Integrating JIT prompt guidance into Python handler | Cleanup only - feature integration deferred to future milestone |
| Restoring "explain" code feature | Cleanup only - feature restoration deferred to future milestone |
| Updating prompt content/quality | Cleanup only - content improvements not in scope |
| Adding new prompt types | Cleanup only - no new capabilities |
| Reorganizing active prompt structure | Active prompts already well-organized in v1.0/v1.1 |
## Traceability
@ -62,26 +64,18 @@ Which phases cover which requirements. Updated during roadmap creation.
| Requirement | Phase | Status |
|-------------|-------|--------|
| STRUCT-01 | Phase 6 - Directory Restructuring | Complete |
| IMPORT-01 | Phase 8 - Codebase Import Updates | Complete |
| IMPORT-02 | Phase 7 - Core Import Migration | Complete |
| IMPORT-03 | Phase 8 - Codebase Import Updates | Complete |
| TEST-01 | Phase 9 - Test Suite Migration | Complete |
| TEST-02 | Phase 9 - Test Suite Migration | Complete |
| TEST-03 | Phase 10 - Test Validation | Complete |
| DOCS-01 | Phase 11 - Documentation Updates | Complete |
| DOCS-02 | Phase 11 - Documentation Updates | Complete |
| DOCS-03 | Phase 11 - Documentation Updates | Complete |
| VERIFY-01 | Phase 12 - Final Verification | Complete |
| VERIFY-02 | Phase 12 - Final Verification | Complete |
| CLEAN-01 | TBD | Pending |
| CLEAN-02 | TBD | Pending |
| CLEAN-03 | TBD | Pending |
| VERIFY-01 | TBD | Pending |
| VERIFY-02 | TBD | Pending |
| DOCS-01 | TBD | Pending |
**Coverage:**
- v1.1 requirements: 12 total
- Mapped to phases: 12 (100%)
- Complete: 12 (100%)
- Unmapped: 0
- v1.2 requirements: 6 total
- Mapped to phases: 0 (roadmap pending)
- Unmapped: 6
---
*Requirements defined: 2026-01-30*
*Last updated: 2026-01-31*
*v1.1 milestone COMPLETE*
*Requirements defined: 2026-01-31*
*Last updated: 2026-01-31 after initial definition*