Added two key usage scenarios to TODO.md for framework development: Scenario 1: Establish codebase from scratch - Research current onboarding experience and setup targets - Identify documentation gaps for new project creation - Validate project initialization workflows - Evaluate agent selection systems for new projects Scenario 2: Integration with existing projects having agents - Research detection of existing agent systems - Design conflict resolution for overlapping functionality - Create migration paths for outdated project agents - Develop extension mechanisms for project-specific customizations - Define integration patterns respecting existing structure - Build tooling for safe agent system transitions These exploration tasks will guide development of capabilities needed to support both greenfield projects and integration scenarios. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
148 lines
6.9 KiB
Markdown
148 lines
6.9 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/KeepaTodofile).
|
|
|
|
The structure organizes **future tasks** by their impact, just as a changelog organizes past changes by their impact.
|
|
|
|
***
|
|
|
|
## [Unreleased] - *Active Vibe-Coding State* 💡
|
|
|
|
This section is for tasks currently being discussed with or worked on by the coding assistant. These are the ephemeral, flow-of-thought tasks.
|
|
|
|
* **To Add:**
|
|
* Pre-commit hooks for automated code quality checks
|
|
* CI/CD pipeline configuration for automated testing and deployment
|
|
* Usage analytics and telemetry for agent effectiveness tracking
|
|
* **Scenario 1 exploration: Establish codebase from scratch**
|
|
* Research current onboarding experience with existing setup targets
|
|
* Identify gaps in documentation for new project creation
|
|
* Test and validate smooth project initialization workflows
|
|
* Evaluate agent selection and recommendation systems for new projects
|
|
* Document best practices for greenfield project setup
|
|
* **Scenario 2 exploration: Integration with existing projects having agents**
|
|
* Research detection of existing agent systems in projects
|
|
* Design conflict resolution strategies for overlapping agent functionality
|
|
* Create migration paths for replacing outdated project-specific agents
|
|
* Develop extension mechanisms for project-specific kaizen agent customizations
|
|
* Define integration patterns that respect existing project structure
|
|
* Build tooling for safe agent system transitions
|
|
* **To Refactor:**
|
|
* Enhanced error handling in CLI with more informative messages
|
|
* Performance optimization for large project installations
|
|
* **To Fix:**
|
|
* Cross-platform compatibility testing for Windows/macOS
|
|
* **To Remove:**
|
|
* Any remaining development scaffolding or temporary files
|
|
|
|
***
|
|
|
|
## [0.3.0] - Enhanced Distribution and Automation - *Next Planned Increment*
|
|
|
|
This version focuses on production readiness and enhanced automation capabilities.
|
|
|
|
### To Add
|
|
* **Pre-commit hooks** integration for automatic code quality enforcement
|
|
* **GitHub Actions workflows** for CI/CD automation
|
|
* **Agent metrics and telemetry** system for usage tracking and optimization
|
|
* **Interactive agent selection** wizard for new projects
|
|
* **Agent template validation** system with schema enforcement
|
|
* **Documentation generation** automation from agent metadata
|
|
|
|
### To Refactor
|
|
* **CLI error handling** with more user-friendly messages and suggestions
|
|
* **Performance optimization** for handling large numbers of agents
|
|
* **Installation process** with progress indicators and detailed feedback
|
|
|
|
### To Fix
|
|
* **Cross-platform compatibility** testing and fixes for Windows/macOS environments
|
|
* **Edge case handling** in dependency resolution algorithms
|
|
* **Memory usage optimization** for large-scale agent installations
|
|
|
|
### To Secure
|
|
* **Agent integrity verification** with checksums and validation
|
|
* **Sandboxed agent execution** for security-sensitive environments
|
|
* **Configuration file validation** to prevent malicious modifications
|
|
|
|
### To Remove
|
|
* **Legacy installation methods** that are no longer supported
|
|
* **Deprecated CLI options** and maintain backward compatibility warnings
|
|
|
|
***
|
|
|
|
## [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
|