Draft workplan with 16 tasks across publish verification, install doc sync, packaged agent parity, CI hardening, and ecosystem handoff. Refresh TODO.md and SCOPE.md; register State Hub workstream.
214 lines
10 KiB
Markdown
214 lines
10 KiB
Markdown
# Todofile
|
|
|
|
This is a "to do next" file, particularly useful to keep the human and a coding assistant in sync.
|
|
|
|
The format is based on [Keep a Todofile V0.0.1](https://coulomb.social/open/TodoFileGuide).
|
|
|
|
The structure organizes **future tasks** by their impact, just as a changelog organizes past changes by their impact.
|
|
|
|
***
|
|
|
|
## [Unreleased] - *Active Vibe-Coding State* 💡
|
|
|
|
Tasks in workplan: `workplans/kaizen-agentic-WP-0005-adoption-parity.md` (v1.2.0)
|
|
|
|
### To Add
|
|
* **Gitea publish pipeline verification** — secrets + workflow smoke test
|
|
* **`make agents-sync-package`** — keep `data/agents/` aligned with `agents/`
|
|
* **Install doc sweep** — HELLO_WORLD, CLI_CHEAT_SHEET, AGENT_DISTRIBUTION
|
|
|
|
### To Refactor
|
|
* **CI lint gate** — flake8 on `src/` in Gitea Actions
|
|
* **Makefile install hints** — point at Gitea registry or dev install
|
|
|
|
### Deferred to WP-0006 (v1.3.0)
|
|
* Interactive agent selection wizard
|
|
* Agent template schema validation in `validate`
|
|
* Documentation generation from agent metadata
|
|
|
|
***
|
|
|
|
## [1.1.0] - Community Engagement — *Shipped 2026-06-18*
|
|
|
|
See `CHANGELOG.md` [1.1.0] and `workplans/kaizen-agentic-WP-0001-community-engagement.md`.
|
|
|
|
***
|
|
|
|
## [COMPLETED] - *Documentation Standards Compliance - Version 0.2.0*
|
|
|
|
### ✅ Completed: To Add
|
|
* **CLI interface** for agent management and execution - DONE
|
|
- Full `kaizen-agentic` CLI with 8 commands (init, install, update, remove, list, status, validate, templates)
|
|
- Console script entry point for global availability
|
|
- Complete command-line interface with options and help
|
|
* **Comprehensive tests** for optimization module (PerformanceMetrics, OptimizationLoop) - DONE
|
|
- 24 tests covering all components with 100% pass rate
|
|
- Test coverage for registry, installer, and core functionality
|
|
- Automated test execution with make test/test-all targets
|
|
* **Agent registry and installer functionality** - DONE
|
|
- Complete AgentRegistry with categorization and dependency resolution
|
|
- AgentInstaller with backup/rollback capabilities
|
|
- ProjectInitializer with template-based project creation
|
|
* **Comprehensive documentation system** - DONE
|
|
- GETTING_STARTED.md - Complete setup and usage guide
|
|
- AGENT_DISTRIBUTION.md - Architecture documentation
|
|
- CLI_CHEAT_SHEET.md - Quick reference guide
|
|
- Updated README.md with complete usage examples
|
|
|
|
### ✅ Completed: To Refactor
|
|
* **Agent definitions** to follow consistent format standards - DONE
|
|
- All 17+ agents updated to YAML frontmatter format
|
|
- Consistent categorization system (project-management, development-process, etc.)
|
|
- Proper dependency declarations and descriptions
|
|
* **Makefile structure** for better user experience - DONE
|
|
- Reorganized with consistent naming (agents-, setup-, standards- prefixes)
|
|
- Enhanced help system with examples and clear descriptions
|
|
- 50+ targets organized into logical sections
|
|
* **Test execution performance** optimization - DONE
|
|
- Fast execution with all 24 tests completing in <1 second
|
|
- Parallel execution capabilities
|
|
- Efficient backup/cleanup in test teardown
|
|
|
|
### ✅ Completed: To Fix
|
|
* **Makefile targets** compatibility across environments - DONE
|
|
- Cross-platform compatibility with proper shell detection
|
|
- Virtual environment handling with fallback mechanisms
|
|
- Error handling and recovery in setup processes
|
|
* **Linting issues** in core modules - DONE
|
|
- All flake8 violations resolved across entire codebase
|
|
- PEP 8 compliance achieved
|
|
- Consistent code formatting with black
|
|
* **Virtual environment setup** reliability - DONE
|
|
- Robust venv creation and activation
|
|
- Dependency installation with upgrade handling
|
|
- Status checking and validation
|
|
* **CLI installation make target (agents-install-cli)** - DONE
|
|
- Target is working properly and requires virtual environment activation as documented
|
|
- Installation process functions correctly with proper venv setup
|
|
* **YAML frontmatter errors in agent files** causing loading failures - DONE
|
|
- All 16 agents now properly loading without YAML parsing errors
|
|
- Frontmatter format standardized across all agent definitions
|
|
* **Agent categorization issues** (agents showing as "Unknown" instead of proper categories) - DONE
|
|
- All 16 agents now properly categorized and displaying correct categories
|
|
- Category mapping and recognition system functioning correctly
|
|
|
|
### ✅ Completed: To Secure
|
|
* **Configuration file validation** - DONE
|
|
- Safe YAML parsing with error handling
|
|
- Input validation for all CLI parameters
|
|
- Backup creation before modifications
|
|
* **Agent integrity checks** - DONE
|
|
- Validation system for agent definitions
|
|
- Dependency conflict detection
|
|
- Installation verification
|
|
|
|
### ✅ Completed: To Remove
|
|
* **Obsolete test fixtures** - DONE
|
|
- Clean test directory structure
|
|
- Removed unused imports and variables
|
|
- Eliminated development scaffolding
|
|
|
|
***
|
|
|
|
## [COMPLETED] - *Scenario 1: Greenfield Project Excellence - Version 0.2.1*
|
|
|
|
### ✅ Completed: Scenario 1 Tasks
|
|
* **Scenario 1 exploration: Establish codebase from scratch** - DONE
|
|
- Research current onboarding experience with existing setup targets - DONE
|
|
- Identify gaps in documentation for new project creation - DONE
|
|
- Test and validate smooth project initialization workflows - DONE
|
|
- Evaluate agent selection and recommendation systems for new projects - DONE
|
|
- Document best practices for greenfield project setup - DONE
|
|
|
|
### ✅ Completed: Additional Scenario 1 Improvements
|
|
* **Agent template name mappings fixed** - DONE
|
|
- Fixed agent template name mappings to match actual agent names
|
|
- Ensured consistency between template references and installed agents
|
|
* **ProjectInitializer enhancements** - DONE
|
|
- Added Makefile creation to ProjectInitializer for complete greenfield setup
|
|
- Implemented comprehensive project scaffolding
|
|
* **Test framework stability** - DONE
|
|
- Fixed all failing tests for agent framework updates
|
|
- Achieved 100% test pass rate across all components
|
|
* **Documentation and tutorial creation** - DONE
|
|
- Updated documentation with correct agent names
|
|
- Created HelloWorld tutorial for new users
|
|
- Comprehensive onboarding experience established
|
|
|
|
### ✅ Completed: Production Readiness
|
|
* **Scenario 1 state achievement** - DONE
|
|
- Scenario 1 (establish codebase from scratch) is now excellent and production-ready
|
|
- Complete end-to-end workflow for greenfield projects
|
|
- Robust agent selection and project initialization
|
|
|
|
***
|
|
|
|
## [COMPLETED] - *Production Release with Release Management - Version 1.0.0*
|
|
|
|
### ✅ Completed: Release Management System
|
|
* **Complete release management system** with agent-releaseManager - DONE
|
|
- 6 structured make targets for complete release workflow
|
|
- `release-check` - Validate release readiness with comprehensive checklist
|
|
- `release-prepare` - Build packages and prepare for publication
|
|
- `release-test` - Test publication workflow using TestPyPI
|
|
- `release-publish` - Publish to production PyPI with safety checks
|
|
- `release-finalize` - Post-release tasks (tags, GitHub releases, documentation)
|
|
- `release-rollback` - Emergency rollback procedures and guidance
|
|
* **Local package installation capability** - DONE
|
|
- `make install-local` target for PyPI-equivalent testing
|
|
- Local package building and installation workflow
|
|
- Integration testing with locally built packages
|
|
* **Documentation updates for installation options** - DONE
|
|
- Updated documentation to reflect all installation methods
|
|
- PyPI installation guidance and local development setup
|
|
- Complete user onboarding documentation
|
|
* **Package distribution readiness** - DONE
|
|
- Full package ready for PyPI publication
|
|
- All agents included in package data distribution
|
|
- Console script entry point for global CLI availability
|
|
- Version 1.0.0 production release achieved
|
|
|
|
***
|
|
|
|
## [COMPLETED] - *Scenario 2: Existing Project Integration Excellence - Version 0.2.2*
|
|
|
|
### ✅ Completed: Scenario 2 Tasks
|
|
* **Scenario 2 exploration: Integration with existing projects having agents** - DONE
|
|
- Research detection of existing agent systems in projects - DONE
|
|
- Design conflict resolution strategies for overlapping agent functionality - DONE
|
|
- Create migration paths for replacing outdated project-specific agents - DONE
|
|
- Develop extension mechanisms for project-specific kaizen agent customizations - DONE
|
|
- Define integration patterns that respect existing project structure - DONE
|
|
- Build tooling for safe agent system transitions - DONE
|
|
|
|
### ✅ Completed: Major Components Built
|
|
* **Detection system (detection.py)** for analyzing existing agent systems - DONE
|
|
- Comprehensive agent system detection across multiple formats
|
|
- Analysis of conflicts and overlap identification
|
|
- Integration readiness assessment
|
|
* **Migration framework (migration.py)** with 5 migration strategies - DONE
|
|
- Replace strategy for complete agent replacement
|
|
- Merge strategy for combining functionalities
|
|
- Extend strategy for adding new capabilities
|
|
- Coexist strategy for parallel operation
|
|
- Archive strategy for deprecation handling
|
|
* **Extension system (extensions.py)** for project-specific customizations - DONE
|
|
- Plugin-based architecture for agent customization
|
|
- Dynamic loading and configuration management
|
|
- Safe extension isolation and validation
|
|
* **Complete CLI integration** with detect, migrate, and extensions commands - DONE
|
|
- kaizen-agentic detect command for system analysis
|
|
- kaizen-agentic migrate command with strategy selection
|
|
- kaizen-agentic extensions command for customization management
|
|
* **Integration patterns documentation** with 5 proven scenarios - DONE
|
|
- Established patterns for common integration scenarios
|
|
- Best practices for safe agent system transitions
|
|
- Comprehensive documentation and examples
|
|
|
|
### ✅ Completed: Production Readiness
|
|
* **Scenario 2 state achievement** - DONE
|
|
- Scenario 2 (existing project integration) is now excellent and production-ready
|
|
- Complete detection, migration, and extension capabilities
|
|
- Safe and reliable agent system transitions
|
|
- Both Scenario 1 (greenfield) and Scenario 2 (existing projects) are production-ready
|