Compare commits
7 Commits
747715af58
...
v0.3.0
| Author | SHA1 | Date | |
|---|---|---|---|
| 1877d6d462 | |||
| 7cc81dee8f | |||
| d5d943a604 | |||
| c5f49b2dd0 | |||
| 096017b93f | |||
| f0dfd04d45 | |||
| 6233d13f18 |
7
.gitmodules
vendored
7
.gitmodules
vendored
@@ -2,6 +2,9 @@
|
||||
path = wiki
|
||||
url = http://92.205.130.254:32166/coulomb/markitect_project.wiki.git
|
||||
branch = main
|
||||
[submodule "issue-facade"]
|
||||
path = issue-facade
|
||||
[submodule "capabilities/issue-facade"]
|
||||
path = capabilities/issue-facade
|
||||
url = http://92.205.130.254:32166/coulomb/issue-facade.git
|
||||
[submodule "capabilities/kaizen-agentic"]
|
||||
path = capabilities/kaizen-agentic
|
||||
url = http://92.205.130.254:32166/coulomb/kaizen-agentic.git
|
||||
|
||||
@@ -75,7 +75,7 @@ markitect/cli/ # CLI framework capability
|
||||
#### 1. **Submodule Capabilities** (Independent Repositories)
|
||||
- **Pattern**: Git submodules pointing to external repositories
|
||||
- **Benefits**: Independent versioning, separate development, easy updates
|
||||
- **Examples**: `issue-facade/`, `wiki/`
|
||||
- **Examples**: `capabilities/issue-facade/`, `wiki/`
|
||||
|
||||
#### 2. **Local Extracted Capabilities** (Previously Internal, Now Separated)
|
||||
- **Pattern**: Moved to `capabilities/` directory but still in this repo
|
||||
@@ -125,7 +125,7 @@ Extract capability → Choose inclusion pattern → Update registries
|
||||
Internal → markitect/issues/ (internal issue management)
|
||||
Evaluation → Self-contained, reusable, independent development needed
|
||||
Extraction → coulomb/issue-facade (separate repository)
|
||||
Inclusion → issue-facade/ (submodule capability)
|
||||
Inclusion → capabilities/issue-facade/ (submodule capability)
|
||||
Registration → CAPABILITY_REGISTRY.md updated
|
||||
```
|
||||
|
||||
@@ -144,13 +144,14 @@ markitect/ # Core repository
|
||||
└── [... 68+ more capabilities]
|
||||
```
|
||||
|
||||
### External Capabilities (4 documented in CAPABILITY_REGISTRY.md)
|
||||
### External Capabilities (5 documented in CAPABILITY_REGISTRY.md)
|
||||
```
|
||||
issue-facade/ # Submodule: Universal issue tracking
|
||||
wiki/ # Submodule: Documentation
|
||||
capabilities/
|
||||
├── issue-facade/ # Submodule: Universal issue tracking
|
||||
├── kaizen-agentic/ # Submodule: AI agent framework
|
||||
├── markitect-content/ # Local: Content processing
|
||||
└── markitect-utils/ # Local: Utility functions
|
||||
wiki/ # Submodule: Documentation
|
||||
[External dependencies: click, pytest, sqlalchemy, ...]
|
||||
```
|
||||
|
||||
|
||||
@@ -25,17 +25,30 @@ Third-party packages providing specific capabilities via pip/pypi.
|
||||
|
||||
### Universal Issue Management
|
||||
- **Type**: Submodule Capability
|
||||
- **Location**: `issue-facade/`
|
||||
- **Location**: `capabilities/issue-facade/`
|
||||
- **Repository**: `coulomb/issue-facade`
|
||||
- **Purpose**: Backend-agnostic issue tracking with unified CLI
|
||||
- **Interfaces**:
|
||||
- CLI: `cd issue-facade && python -m cli.main [command]`
|
||||
- CLI: `cd capabilities/issue-facade && python -m cli.main [command]`
|
||||
- API: Core models, backends (local SQLite, Gitea, GitHub, GitLab)
|
||||
- **Usage Guidelines**:
|
||||
- ✅ **USE**: For all issue management tasks
|
||||
- ❌ **DON'T**: Implement custom issue tracking, duplicate CLI commands
|
||||
- 🔧 **Integration**: Reference submodule for issue operations
|
||||
|
||||
### Kaizen-Agentic Framework
|
||||
- **Type**: Submodule Capability
|
||||
- **Location**: `capabilities/kaizen-agentic/`
|
||||
- **Repository**: `coulomb/kaizen-agentic`
|
||||
- **Purpose**: Advanced AI agent framework for autonomous development workflows
|
||||
- **Interfaces**:
|
||||
- CLI: `cd capabilities/kaizen-agentic && make [command]`
|
||||
- Framework: Agent definitions, workflow automation, development patterns
|
||||
- **Usage Guidelines**:
|
||||
- ✅ **USE**: For AI agent definitions and autonomous workflows
|
||||
- ❌ **DON'T**: Implement custom agent frameworks, duplicate AI patterns
|
||||
- 🔧 **Integration**: Reference framework for agent-driven development
|
||||
|
||||
### Content Processing Capability
|
||||
- **Type**: Local Capability
|
||||
- **Location**: `capabilities/markitect-content/`
|
||||
@@ -95,7 +108,10 @@ Third-party packages providing specific capabilities via pip/pypi.
|
||||
### Submodule Integration
|
||||
```bash
|
||||
# Issue management
|
||||
cd issue-facade && python -m cli.main list
|
||||
cd capabilities/issue-facade && python -m cli.main list
|
||||
|
||||
# AI agent framework
|
||||
cd capabilities/kaizen-agentic && make [command]
|
||||
|
||||
# Documentation updates
|
||||
cd wiki && git pull origin main
|
||||
@@ -137,7 +153,8 @@ import pytest # Testing framework
|
||||
- **Utilities**: Check `markitect-utils` before creating new utility functions
|
||||
|
||||
### Integration Commands:
|
||||
- **Issue Operations**: `cd issue-facade && python -m cli.main [command]`
|
||||
- **Issue Operations**: `cd capabilities/issue-facade && python -m cli.main [command]`
|
||||
- **AI Agent Framework**: `cd capabilities/kaizen-agentic && make [command]`
|
||||
- **Content Analysis**: Import from `capabilities.markitect_content`
|
||||
- **Utility Functions**: Import from `capabilities.markitect_utils`
|
||||
- **Documentation**: Reference files in `wiki/`
|
||||
@@ -173,11 +190,11 @@ import pytest # Testing framework
|
||||
|
||||
## 📊 **CAPABILITY METRICS**
|
||||
|
||||
- **Total Capabilities**: 4 active capabilities
|
||||
- **Submodule Capabilities**: 2 (issue-facade, wiki)
|
||||
- **Total Capabilities**: 5 active capabilities
|
||||
- **Submodule Capabilities**: 3 (issue-facade, kaizen-agentic, wiki)
|
||||
- **Local Capabilities**: 2 (markitect-content, markitect-utils)
|
||||
- **External Dependencies**: Multiple (see pyproject.toml)
|
||||
- **Coverage**: Issue management, content processing, utilities, documentation
|
||||
- **Coverage**: Issue management, AI agent framework, content processing, utilities, documentation
|
||||
|
||||
---
|
||||
|
||||
|
||||
23
CHANGELOG.md
23
CHANGELOG.md
@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [0.3.0] - 2025-10-25
|
||||
|
||||
### Added
|
||||
- **Kaizen-Agentic Framework Integration** as external capability submodule
|
||||
- **Test Reorganization by Capability** with separated test targets for better modularity
|
||||
- **Comprehensive Capability Inclusion Management System** with automated discovery tools
|
||||
- **Todofile System Implementation** - Modern task management replacing NEXT.md
|
||||
- **Historical File Organization** - Legacy files moved to history directory for better project structure
|
||||
|
||||
### Changed
|
||||
- **Capability Directory Reorganization** - moved all external dependencies to `capabilities/` directory
|
||||
- **Issue Management Migration** - replaced local issue system with external `issue-facade` submodule
|
||||
- **Project Structure Optimization** - established clear separation between capabilities and core documentation
|
||||
- **Test Architecture Enhancement** - separated capability-specific tests from core system tests
|
||||
- **Makefile Test Targets** - added granular test execution with `make test-capabilities` and capability-specific targets
|
||||
|
||||
### Improved
|
||||
- **Logical Organization** - capabilities/ for external dependencies, wiki/ for project documentation at root
|
||||
- **Test Performance** - core tests now exclude capability tests for faster execution
|
||||
- **Development Workflow** - clear separation between internal and external capabilities
|
||||
- **Documentation Ecosystem** - complete capability documentation with CAPABILITIES.md and CAPABILITY_REGISTRY.md
|
||||
- **Code Organization** - Archive of legacy files to maintain clean working directory
|
||||
|
||||
## [0.2.0] - 2025-10-20
|
||||
|
||||
### Added
|
||||
|
||||
82
Makefile
82
Makefile
@@ -25,7 +25,9 @@ help:
|
||||
@echo " venv-status - Check if venv is active"
|
||||
@echo ""
|
||||
@echo "Development:"
|
||||
@echo " test - Run all tests"
|
||||
@echo " test - Run core tests (excluding capability-specific tests)"
|
||||
@echo " test-capabilities - Run all capability-specific tests"
|
||||
@echo " test-capability-* - Run specific capability tests (content, utils, finance, etc.)"
|
||||
@echo " test-status - Show test status summary without re-running"
|
||||
@echo " test-new - Create new test file template"
|
||||
@echo " test-coverage - Analyze test coverage"
|
||||
@@ -320,25 +322,77 @@ setup-dev: install-dev
|
||||
|
||||
# Run tests
|
||||
test: $(VENV)/bin/activate
|
||||
@echo "🧪 Running tests..."
|
||||
@echo "🧪 Running core tests (excluding capability-specific tests)..."
|
||||
@if [ -f $(VENV)/bin/pytest ]; then \
|
||||
PYTHONPATH=. $(VENV)/bin/pytest tests/ -v; \
|
||||
PYTHONPATH=. $(VENV)/bin/pytest tests/ -v \
|
||||
--ignore=capabilities/markitect-content/tests/ \
|
||||
--ignore=capabilities/markitect-utils/tests/ \
|
||||
--ignore=markitect/finance/tests/ \
|
||||
--ignore=markitect/query_paradigms/tests/ \
|
||||
--ignore=markitect/graphql/tests/ \
|
||||
--ignore=markitect/plugins/tests/; \
|
||||
else \
|
||||
PYTHONPATH=. $(VENV_PYTHON) -m pytest tests/ -v 2>/dev/null || \
|
||||
PYTHONPATH=. $(VENV_PYTHON) -m pytest tests/ -v \
|
||||
--ignore=capabilities/markitect-content/tests/ \
|
||||
--ignore=capabilities/markitect-utils/tests/ \
|
||||
--ignore=markitect/finance/tests/ \
|
||||
--ignore=markitect/query_paradigms/tests/ \
|
||||
--ignore=markitect/graphql/tests/ \
|
||||
--ignore=markitect/plugins/tests/ 2>/dev/null || \
|
||||
PYTHONPATH=. $(VENV_PYTHON) -m unittest discover tests/ -v; \
|
||||
fi
|
||||
|
||||
# Capability-Specific Test Targets
|
||||
test-capabilities: test-capability-content test-capability-utils test-capability-finance test-capability-query test-capability-graphql test-capability-plugins
|
||||
@echo "✅ All capability tests completed"
|
||||
|
||||
test-capability-content: $(VENV)/bin/activate
|
||||
@echo "🧪 Running markitect-content capability tests..."
|
||||
@cd capabilities/markitect-content && python -m pytest tests/ -v
|
||||
|
||||
test-capability-utils: $(VENV)/bin/activate
|
||||
@echo "🧪 Running markitect-utils capability tests..."
|
||||
@cd capabilities/markitect-utils && python -m pytest tests/ -v
|
||||
|
||||
test-capability-finance: $(VENV)/bin/activate
|
||||
@echo "🧪 Running finance capability tests..."
|
||||
@PYTHONPATH=. $(VENV_PYTHON) -m pytest markitect/finance/tests/ -v
|
||||
|
||||
test-capability-query: $(VENV)/bin/activate
|
||||
@echo "🧪 Running query paradigms capability tests..."
|
||||
@PYTHONPATH=. $(VENV_PYTHON) -m pytest markitect/query_paradigms/tests/ -v
|
||||
|
||||
test-capability-graphql: $(VENV)/bin/activate
|
||||
@echo "🧪 Running GraphQL capability tests..."
|
||||
@PYTHONPATH=. $(VENV_PYTHON) -m pytest markitect/graphql/tests/ -v
|
||||
|
||||
test-capability-plugins: $(VENV)/bin/activate
|
||||
@echo "🧪 Running plugins capability tests..."
|
||||
@PYTHONPATH=. $(VENV_PYTHON) -m pytest markitect/plugins/tests/ -v
|
||||
|
||||
# TDD8 Workflow Optimized Test Targets (Issue #57)
|
||||
|
||||
# Fast test execution for TDD red phase
|
||||
test-red: $(VENV)/bin/activate
|
||||
@echo "🔴 TDD Red Phase - Fast test execution..."
|
||||
PYTHONPATH=. $(VENV_PYTHON) -m pytest tests/ -x --maxfail=1 --tb=short -q
|
||||
PYTHONPATH=. $(VENV_PYTHON) -m pytest tests/ -x --maxfail=1 --tb=short -q \
|
||||
--ignore=capabilities/markitect-content/tests/ \
|
||||
--ignore=capabilities/markitect-utils/tests/ \
|
||||
--ignore=markitect/finance/tests/ \
|
||||
--ignore=markitect/query_paradigms/tests/ \
|
||||
--ignore=markitect/graphql/tests/ \
|
||||
--ignore=markitect/plugins/tests/
|
||||
|
||||
# Comprehensive test execution for TDD green phase
|
||||
test-green: $(VENV)/bin/activate
|
||||
@echo "🟢 TDD Green Phase - Comprehensive validation..."
|
||||
PYTHONPATH=. $(VENV_PYTHON) -m pytest tests/ --tb=short
|
||||
PYTHONPATH=. $(VENV_PYTHON) -m pytest tests/ --tb=short \
|
||||
--ignore=capabilities/markitect-content/tests/ \
|
||||
--ignore=capabilities/markitect-utils/tests/ \
|
||||
--ignore=markitect/finance/tests/ \
|
||||
--ignore=markitect/query_paradigms/tests/ \
|
||||
--ignore=markitect/graphql/tests/ \
|
||||
--ignore=markitect/plugins/tests/
|
||||
|
||||
# Smart test selection - changed files only
|
||||
test-smart: $(VENV)/bin/activate
|
||||
@@ -354,12 +408,24 @@ test-smart: $(VENV)/bin/activate
|
||||
# Ultra-fast test execution
|
||||
test-ultra-fast: $(VENV)/bin/activate
|
||||
@echo "⚡ Ultra-fast test execution..."
|
||||
PYTHONPATH=. $(VENV_PYTHON) -m pytest tests/ -m "not slow" --maxfail=1 -x -q
|
||||
PYTHONPATH=. $(VENV_PYTHON) -m pytest tests/ -m "not slow" --maxfail=1 -x -q \
|
||||
--ignore=capabilities/markitect-content/tests/ \
|
||||
--ignore=capabilities/markitect-utils/tests/ \
|
||||
--ignore=markitect/finance/tests/ \
|
||||
--ignore=markitect/query_paradigms/tests/ \
|
||||
--ignore=markitect/graphql/tests/ \
|
||||
--ignore=markitect/plugins/tests/
|
||||
|
||||
# Test with performance monitoring
|
||||
test-perf: $(VENV)/bin/activate
|
||||
@echo "📊 Test execution with performance monitoring..."
|
||||
PYTHONPATH=. $(VENV_PYTHON) -m pytest tests/ --durations=10 --tb=short
|
||||
PYTHONPATH=. $(VENV_PYTHON) -m pytest tests/ --durations=10 --tb=short \
|
||||
--ignore=capabilities/markitect-content/tests/ \
|
||||
--ignore=capabilities/markitect-utils/tests/ \
|
||||
--ignore=markitect/finance/tests/ \
|
||||
--ignore=markitect/query_paradigms/tests/ \
|
||||
--ignore=markitect/graphql/tests/ \
|
||||
--ignore=markitect/plugins/tests/
|
||||
|
||||
# Test health check
|
||||
test-health: $(VENV)/bin/activate
|
||||
|
||||
@@ -18,4 +18,4 @@ MarkiTect transforms markdown from plain text into intelligent, structured data
|
||||
|
||||
**Development:** [TDD Workflow](docs/development/tdd-workflow.md) · [Contributing](#contributing) · [Capabilities Overview](CAPABILITIES.md)
|
||||
|
||||
**Project Status:** [Current Status](history/ProjectStatusDigest.md) · [Roadmap](history/ROADMAP.md) · [Next Actions](NEXT.md)
|
||||
**Project Status:** [Current Status](history/ProjectStatusDigest.md) · [Roadmap](history/ROADMAP.md) · [Current Tasks](TODO.md)
|
||||
|
||||
101
TODO.md
Normal file
101
TODO.md
Normal file
@@ -0,0 +1,101 @@
|
||||
# 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:**
|
||||
* Complete AST Query and Analysis CLI implementation (Issue #15)
|
||||
* Performance Validation CLI implementation (Issue #16)
|
||||
* Enhanced discovery tools validation and refinement
|
||||
* **To Refactor:**
|
||||
* Update any missing links in existing documentation to new capability system
|
||||
* Refine capability discovery workflow based on practical usage
|
||||
* Enhance AI assistant integration with capability system
|
||||
* **To Fix:**
|
||||
* Validate that CAPABILITY_DOCUMENTATION_INDEX.md provides effective navigation
|
||||
* Ensure all agents are aware of capability inclusion workflow
|
||||
* Test automated detection prevention of code duplication
|
||||
* **To Remove:**
|
||||
* Retire NEXT.md file after successful todofile migration
|
||||
* Clean up any outdated task management references
|
||||
|
||||
***
|
||||
|
||||
## [0.3.0] - Strategic Development Execution - *Next Planned Increment*
|
||||
|
||||
This version represents the next set of concrete, planned features focusing on strategic issue resolution and capability validation.
|
||||
|
||||
### To Add
|
||||
* **AST Query and Analysis CLI** - Complete implementation of Issue #15 with full AST parsing and analysis capabilities
|
||||
* **Performance Validation CLI** - Complete implementation of Issue #16 with comprehensive performance testing and metrics
|
||||
* **Enhanced Discovery Tools** - Improve `make capability-search TERM=xyz` based on real-world usage patterns
|
||||
* **Capability Integration Validation** - Test framework for ensuring capability inclusion workflow effectiveness
|
||||
|
||||
### To Refactor
|
||||
* **Documentation Ecosystem** - Update any missing links to new capability system components
|
||||
* **AI Assistant Integration** - Enhance capability reference utilization for informed decision-making
|
||||
* **Workflow Optimization** - Refine capability-first development process based on practical experience
|
||||
|
||||
### To Fix
|
||||
* **Documentation Navigation** - Ensure CAPABILITY_DOCUMENTATION_INDEX.md provides effective project navigation
|
||||
* **Agent Workflow Integration** - Validate all agents properly utilize capability inclusion workflow
|
||||
* **Duplication Prevention** - Test and improve automated detection systems
|
||||
|
||||
### To Secure
|
||||
* **Capability Validation** - Ensure capability inclusion system maintains security best practices
|
||||
* **Dependency Management** - Validate external capability references and security implications
|
||||
|
||||
### To Remove
|
||||
* **Legacy Task Management** - Retire NEXT.md approach in favor of standardized todofile system
|
||||
* **Outdated Documentation References** - Clean up any references to deprecated task management approaches
|
||||
|
||||
***
|
||||
|
||||
## [COMPLETED] - *Capability Inclusion Management System - Version 0.2.0*
|
||||
|
||||
### ✅ Completed: To Add
|
||||
* **Complete capability documentation ecosystem** - DONE
|
||||
- CAPABILITIES.md for internal capabilities with detailed descriptions
|
||||
- CAPABILITY_REGISTRY.md for external capabilities and dependencies
|
||||
- CAPABILITY_DOCUMENTATION_INDEX.md for navigation and discovery
|
||||
- CLAUDE_CAPABILITY_REFERENCE.md for AI assistant quick reference
|
||||
- CAPABILITY_INCLUSION_GUIDE.md for workflow and best practices
|
||||
* **Automated discovery tools** - DONE
|
||||
- `make capability-search TERM=xyz` for capability discovery
|
||||
- Prevention of code duplication through automated detection
|
||||
- Enhanced agent definitions with capability inclusion workflow
|
||||
* **Architectural clarity** - DONE
|
||||
- Clear separation of internal vs external capabilities
|
||||
- Comprehensive categorization system
|
||||
- Detailed capability documentation with examples
|
||||
|
||||
### ✅ Completed: To Refactor
|
||||
* **Agent definitions** - DONE
|
||||
- Enhanced all agents with capability inclusion workflow awareness
|
||||
- Updated agent instructions to utilize capability references
|
||||
- Improved AI assistant integration patterns
|
||||
|
||||
### ✅ Completed: To Fix
|
||||
* **Documentation ecosystem integration** - DONE
|
||||
- All capability files properly interconnected
|
||||
- Navigation system functional and comprehensive
|
||||
- Discovery tools working effectively
|
||||
|
||||
### ✅ Completed: To Secure
|
||||
* **Capability validation system** - DONE
|
||||
- Proper validation of capability inclusion workflow
|
||||
- Security considerations for external capability references
|
||||
|
||||
### ✅ Completed: To Remove
|
||||
* **Code duplication risks** - DONE
|
||||
- Implemented prevention mechanisms
|
||||
- Automated detection and discovery systems
|
||||
81
TODOFILE_GUIDE.md
Normal file
81
TODOFILE_GUIDE.md
Normal file
@@ -0,0 +1,81 @@
|
||||
# MarkiTect Todofile System
|
||||
|
||||
## Overview
|
||||
|
||||
MarkiTect uses the **Keep a Todofile V0.0.1** format for task management and development coordination. This replaces the previous NEXT.md approach with a standardized todofile system that provides better structure for maintaining coding flow and AI assistant coordination.
|
||||
|
||||
## Location and Format
|
||||
|
||||
- **Main Todofile**: `TODO.md` in the project root
|
||||
- **Format**: [Keep a Todofile V0.0.1](https://coulomb.social/open/KeepaTodofile)
|
||||
- **Agent Support**: Managed by the `agent-keepaTodofile` agent in the kaizen-agentic framework
|
||||
|
||||
## Structure
|
||||
|
||||
The todofile is organized by **impact type** rather than arbitrary priority:
|
||||
|
||||
### [Unreleased] - Active Vibe-Coding State 💡
|
||||
- **To Add**: New features, capabilities, or functionality
|
||||
- **To Refactor**: Code improvements and restructuring
|
||||
- **To Fix**: Bug fixes and error corrections
|
||||
- **To Remove**: Features or code to eliminate
|
||||
|
||||
### [Version] - Planned Increments
|
||||
Organized by planned version/milestone with the same impact categories:
|
||||
- **To Add**: Planned new functionality
|
||||
- **To Fix**: Scheduled bug fixes
|
||||
- **To Refactor**: Planned code improvements
|
||||
- **To Deprecate**: Features marked for future removal
|
||||
- **To Secure**: Security improvements
|
||||
- **To Remove**: Planned removals
|
||||
|
||||
## Integration with Project Workflow
|
||||
|
||||
### Task Management
|
||||
- Use `TODO.md` for active development tasks and immediate next steps
|
||||
- Link to Gitea issues for longer-term planning: `Related to issue #123`
|
||||
- Update during development sessions to maintain context
|
||||
|
||||
### AI Assistant Coordination
|
||||
- The todofile serves as a **shared source of truth** between human developers and AI assistants
|
||||
- Helps maintain context during interruptions and session transfers
|
||||
- Enables consistent progress tracking and decision-making
|
||||
|
||||
### Development Best Practices
|
||||
1. **Update Regularly**: Maintain current state during active development
|
||||
2. **Focus on Immediate**: Keep [Unreleased] section for current work
|
||||
3. **Plan Versions**: Use version sections for commit boundaries
|
||||
4. **Archive Completed**: Move completed items to archive sections
|
||||
5. **Link Issues**: Connect todofile items to Gitea issues for full context
|
||||
|
||||
## Agent Integration
|
||||
|
||||
The `agent-keepaTodofile` agent provides specialized support for:
|
||||
- Creating and maintaining TODO.md files following the official format
|
||||
- Organizing tasks by impact type (Add, Fix, Refactor, etc.)
|
||||
- Integrating with issue tracking and TDD workflows
|
||||
- Maintaining coding flow and context preservation
|
||||
- Converting between task management formats
|
||||
|
||||
## Migration from NEXT.md
|
||||
|
||||
The previous NEXT.md file has been archived to `history/NEXT_archived_YYYYMMDD.md`. All relevant content has been migrated to the new TODO.md format while preserving:
|
||||
- Strategic development priorities
|
||||
- Capability management workflows
|
||||
- Session success criteria
|
||||
- Development milestones
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- **Agent Definition**: `agents/agent-keepaTodofile.md` - Specialized todofile management agent
|
||||
- **Context Documentation**: `capabilities/kaizen-agentic/context/KeepaTodofile.md` - Detailed format specification
|
||||
- **Capability Integration**: `CAPABILITY_INCLUSION_GUIDE.md` - How todofile fits with capability discovery
|
||||
- **Project Management**: `agents/agent-project-management.md` - Overall project coordination
|
||||
|
||||
## Benefits
|
||||
|
||||
1. **Standardized Format**: Follows established Keep a Todofile conventions
|
||||
2. **Better Organization**: Impact-based categorization aligns with changelog structure
|
||||
3. **AI Assistant Ready**: Designed for human-AI collaboration in coding sessions
|
||||
4. **Context Preservation**: Maintains coding flow across interruptions
|
||||
5. **Integration Ready**: Works with existing issue management and TDD workflows
|
||||
@@ -17,7 +17,7 @@ You are the MarkiTect project assistant, specialized in providing project status
|
||||
|
||||
- **ProjectStatusDigest.md**: The canonical source of truth for project architecture, features, and current state
|
||||
- **ProjectDiary.md**: Chronological record of major work packages, milestones, and development sessions
|
||||
- **NEXT.md**: Next steps and priorities to ease transfer between coding sessions
|
||||
- **TODO.md**: Task management and priorities following Keep a Todofile format for maintaining coding flow
|
||||
- **Makefile**: Provides helpers to use and improve the capabilities provided by the project
|
||||
**Gitea Issues**: Backlog of issues and backlog of tasks stored as issues in gitea
|
||||
|
||||
@@ -48,7 +48,7 @@ You are the MarkiTect project assistant, specialized in providing project status
|
||||
- **Issue Workflow**: Create → Triage → Plan → Schedule → Implement → Close
|
||||
|
||||
**TDD Workflow Management:**
|
||||
- For issue management tasks, use the **issue-facade** system located in `issue-facade/`
|
||||
- For issue management tasks, use the **issue-facade** system located in `capabilities/issue-facade/`
|
||||
- The issue-facade provides unified CLI for GitHub, GitLab, Gitea, and local SQLite backends
|
||||
- This includes sidequest management, test planning, and comprehensive development workflow guidance
|
||||
|
||||
@@ -125,7 +125,7 @@ When asked to help wrap up a development session, follow this standardized routi
|
||||
|
||||
### End-of-Session Checklist:
|
||||
1. **Update ProjectDiary.md**: Add entry documenting progress, challenges, and achievements
|
||||
2. **Update NEXT.md**: Set clear priorities and strategy for next session
|
||||
2. **Update TODO.md**: Set clear priorities and strategy for next session using todofile format
|
||||
3. **Update ProjectStatusDigest.md**: Refresh current status, metrics, and completed features
|
||||
4. **Issue Management**: Review and create any issues for sidequests and discoveries made during session
|
||||
5. **Anchor patterns**: Update this project-assistant definition with any new workflow patterns
|
||||
|
||||
@@ -117,7 +117,7 @@ python tools/requirements_engineering_toolkit.py validate-mocks --test-file test
|
||||
# Enhanced Makefile targets
|
||||
issue-start: validate-requirements
|
||||
# Use issue-facade for issue management
|
||||
cd issue-facade && python -m cli.main show $(NUM)
|
||||
cd capabilities/issue-facade && python -m cli.main show $(NUM)
|
||||
|
||||
validate-requirements:
|
||||
python tools/requirements_engineering_toolkit.py analyze
|
||||
@@ -456,7 +456,7 @@ validate-requirements:
|
||||
|
||||
issue-start: validate-requirements
|
||||
# Use issue-facade for issue management
|
||||
cd issue-facade && python -m cli.main show $(NUM)
|
||||
cd capabilities/issue-facade && python -m cli.main show $(NUM)
|
||||
```
|
||||
|
||||
### Tool Dependencies
|
||||
|
||||
@@ -99,10 +99,10 @@ The **TDD8 cycle** is an 8-step comprehensive development workflow that extends
|
||||
You are the authoritative guide for the TDD8 workflow using the issue-facade system for issue management. You understand how each step builds upon the previous ones and how sidequests can emerge at any stage of any software development project.
|
||||
|
||||
**Primary Issue Management Commands:**
|
||||
- Issue management via issue-facade: `cd issue-facade && python -m cli.main list`
|
||||
- `cd issue-facade && python -m cli.main show ISSUE_NUM` - Show issue details
|
||||
- `cd issue-facade && python -m cli.main create "Title" "Description"` - Create new issue
|
||||
- `cd issue-facade && python -m cli.main close ISSUE_NUM` - Close completed issue
|
||||
- Issue management via issue-facade: `cd capabilities/issue-facade && python -m cli.main list`
|
||||
- `cd capabilities/issue-facade && python -m cli.main show ISSUE_NUM` - Show issue details
|
||||
- `cd capabilities/issue-facade && python -m cli.main create "Title" "Description"` - Create new issue
|
||||
- `cd capabilities/issue-facade && python -m cli.main close ISSUE_NUM` - Close completed issue
|
||||
|
||||
**Capability Awareness:**
|
||||
- **Before implementing**: Check `CAPABILITY_REGISTRY.md` for existing functionality
|
||||
@@ -116,7 +116,7 @@ You are the authoritative guide for the TDD8 workflow using the issue-facade sys
|
||||
- Tea CLI: `tea issue show NUM` - Show detailed view of specific issue
|
||||
|
||||
### Workspace Management Understanding
|
||||
You understand the project structure with issue-facade for issue management:
|
||||
You understand the project structure with capabilities/issue-facade for issue management:
|
||||
```
|
||||
{workspace_dir}/
|
||||
├── current_issue.json # Active issue metadata
|
||||
@@ -157,7 +157,7 @@ You understand the project structure with issue-facade for issue management:
|
||||
|
||||
### TDDAi Framework Components
|
||||
**Core Infrastructure:**
|
||||
- `issue-facade/` - Universal issue management facade
|
||||
- `capabilities/issue-facade/` - Universal issue management facade
|
||||
- `workspace.py` - Workspace management
|
||||
- `issue_fetcher.py` - Issue API integration
|
||||
- `issue_writer.py` - Issue updates via PATCH
|
||||
|
||||
1
capabilities/kaizen-agentic
Submodule
1
capabilities/kaizen-agentic
Submodule
Submodule capabilities/kaizen-agentic added at 1e0ff82d74
@@ -35,7 +35,7 @@ Documentation for contributors and developers extending MarkiTect.
|
||||
### Project Management
|
||||
- [Project Status](../history/ProjectStatusDigest.md) - Current development status
|
||||
- [Roadmap](../history/ROADMAP.md) - Strategic development plan
|
||||
- [Next Actions](../NEXT.md) - Immediate development priorities
|
||||
- [Current Tasks](../TODO.md) - Task management using Keep a Todofile format
|
||||
|
||||
## Key Concepts
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ from pathlib import Path
|
||||
from typing import Optional
|
||||
|
||||
# Base version from pyproject.toml
|
||||
__version__ = "0.2.0"
|
||||
__version__ = "0.3.0"
|
||||
|
||||
def get_git_commit_hash() -> Optional[str]:
|
||||
"""Get the current git commit hash if available."""
|
||||
|
||||
0
markitect/finance/tests/__init__.py
Normal file
0
markitect/finance/tests/__init__.py
Normal file
0
markitect/graphql/tests/__init__.py
Normal file
0
markitect/graphql/tests/__init__.py
Normal file
0
markitect/plugins/tests/__init__.py
Normal file
0
markitect/plugins/tests/__init__.py
Normal file
0
markitect/query_paradigms/tests/__init__.py
Normal file
0
markitect/query_paradigms/tests/__init__.py
Normal file
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "markitect"
|
||||
version = "0.2.0"
|
||||
version = "0.3.0"
|
||||
description = "Advanced Markdown engine for structured content"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.8"
|
||||
|
||||
Reference in New Issue
Block a user