docs: update ProjectStatusDigest with TDD infrastructure
- Add comprehensive TDD Infrastructure section with tddai library - Update Current State to reflect complete TDD implementation - Update Development Tools to include pytest and TDD automation - Expand Repository Structure to show tddai library and CLI - Add complete TDD Workflow section with tdd- prefixed targets - Update Issue Management section with Gitea API integration - Reflect 20+ passing tests and AI-assisted development cycle - Update getting started guide with new workflow commands ProjectStatusDigest now accurately represents the mature TDD-enabled development environment with comprehensive tooling and automation. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -12,10 +12,17 @@ Transform Markdown from plain text into intelligent, structured, reusable data w
|
|||||||
|
|
||||||
### MarkiTect Library (Python Core)
|
### MarkiTect Library (Python Core)
|
||||||
- **Reusable Python package** designed for CLI, service offerings, and third-party integration
|
- **Reusable Python package** designed for CLI, service offerings, and third-party integration
|
||||||
- **TDD approach** with comprehensive test coverage
|
- **TDD approach** with comprehensive test coverage and pytest framework
|
||||||
- **Modern packaging** using `pyproject.toml` and semantic versioning
|
- **Modern packaging** using `pyproject.toml` and semantic versioning
|
||||||
- **Minimal dependencies** with `markdown-it-py` as primary parser
|
- **Minimal dependencies** with `markdown-it-py` as primary parser
|
||||||
|
|
||||||
|
### TDD Infrastructure (tddai Library)
|
||||||
|
- **Complete TDD workspace management** with Python library architecture
|
||||||
|
- **Issue-driven development** with Gitea API integration
|
||||||
|
- **AI-assisted test generation** framework for automated TDD workflows
|
||||||
|
- **Workspace lifecycle management** from issue creation to test integration
|
||||||
|
- **CLI interface** (`tddai_cli.py`) for seamless command-line operations
|
||||||
|
|
||||||
### MarkiTect CLI (Command-Line Interface)
|
### MarkiTect CLI (Command-Line Interface)
|
||||||
- **SQLite database** for temporary, in-memory operations
|
- **SQLite database** for temporary, in-memory operations
|
||||||
- **GraphQL API** using `graphene` library for read/write operations
|
- **GraphQL API** using `graphene` library for read/write operations
|
||||||
@@ -45,10 +52,11 @@ Transform Markdown from plain text into intelligent, structured, reusable data w
|
|||||||
## Development Approach
|
## Development Approach
|
||||||
|
|
||||||
### Test-Driven Development
|
### Test-Driven Development
|
||||||
- Comprehensive **TDD guide** integrated into project workflow
|
- **Complete TDD infrastructure** with `tddai` Python library
|
||||||
- **Test-first approach** for all new features
|
- **Issue-driven workflow** with workspace management (`tdd-start`, `tdd-add-test`, `tdd-status`, `tdd-finish`)
|
||||||
- **High coverage** requirements for public APIs
|
- **20+ passing tests** using pytest with proper behavior-based testing
|
||||||
- **Integration tests** for key workflows
|
- **AI-assisted test generation** integrated into development cycle
|
||||||
|
- **Green-state validation** before all commits
|
||||||
|
|
||||||
### Markdown Feature Support (MF-1 through MF-10)
|
### Markdown Feature Support (MF-1 through MF-10)
|
||||||
Complete specification coverage including:
|
Complete specification coverage including:
|
||||||
@@ -63,23 +71,26 @@ Complete specification coverage including:
|
|||||||
## Project Status
|
## Project Status
|
||||||
|
|
||||||
### Current State
|
### Current State
|
||||||
- **Early development phase** with foundational parser implemented
|
- **TDD infrastructure complete** with robust Python library architecture
|
||||||
- **Comprehensive documentation** and architecture planning complete
|
- **Issue-driven development workflow** fully operational
|
||||||
- **Build system** with sophisticated Makefile for development workflow
|
- **Comprehensive test suite** with 20 passing tests and pytest integration
|
||||||
- **Virtual environment management** with activation detection
|
- **Build system** with sophisticated Makefile and virtual environment integration
|
||||||
|
- **AI-assisted development** cycle with workspace management
|
||||||
|
|
||||||
### Social Integration
|
### Social Integration
|
||||||
- **CoulombSocial participation** since September 2025
|
- **CoulombSocial participation** since September 2025
|
||||||
- **GitLab issues integration** for use case tracking
|
- **Gitea issues integration** with API-driven workflow management
|
||||||
- **Open-source development** model with collaborative wiki
|
- **Open-source development** model with collaborative wiki
|
||||||
|
- **Issue-to-test automation** for structured development cycles
|
||||||
|
|
||||||
## Technical Foundation
|
## Technical Foundation
|
||||||
|
|
||||||
### Development Tools
|
### Development Tools
|
||||||
- **Python 3.8+** with modern tooling (Black, Ruff, mypy)
|
- **Python 3.8+** with modern tooling (Black, Ruff, mypy, pytest)
|
||||||
- **Make-based workflow** with intelligent environment detection
|
- **Make-based workflow** with intelligent environment detection and TDD integration
|
||||||
- **Git submodules** for wiki documentation management
|
- **Git submodules** for wiki documentation management
|
||||||
- **Automated testing** and CI/CD pipeline planning
|
- **tddai library** for complete TDD workspace automation
|
||||||
|
- **Issue management** with Gitea API integration and CLI tools
|
||||||
|
|
||||||
### Brand Identity
|
### Brand Identity
|
||||||
- **Professional visual identity** with 3D "M" logo incorporating Markdown symbols
|
- **Professional visual identity** with 3D "M" logo incorporating Markdown symbols
|
||||||
@@ -93,12 +104,23 @@ markitect_project/
|
|||||||
├── markitect/ # Main Python package
|
├── markitect/ # Main Python package
|
||||||
│ ├── __init__.py
|
│ ├── __init__.py
|
||||||
│ └── parser.py # Core parsing functionality
|
│ └── parser.py # Core parsing functionality
|
||||||
├── tests/ # Test suite
|
├── tddai/ # TDD infrastructure library
|
||||||
│ └── test_parser.py # Parser tests
|
│ ├── __init__.py # Package exports
|
||||||
|
│ ├── workspace.py # Workspace lifecycle management
|
||||||
|
│ ├── issue_fetcher.py # Gitea API integration
|
||||||
|
│ ├── test_generator.py # AI-assisted test generation
|
||||||
|
│ ├── config.py # Configuration management
|
||||||
|
│ └── exceptions.py # Custom exception hierarchy
|
||||||
|
├── tests/ # Comprehensive test suite (20+ tests)
|
||||||
|
│ ├── test_parser.py # Parser tests
|
||||||
|
│ ├── test_issue_11_*.py # TDD infrastructure tests
|
||||||
|
│ └── test_*.py # Additional test modules
|
||||||
|
├── tddai_cli.py # TDD CLI interface
|
||||||
├── wiki/ # Git submodule with comprehensive documentation
|
├── wiki/ # Git submodule with comprehensive documentation
|
||||||
├── Makefile # Development workflow automation
|
├── Makefile # Development workflow automation with TDD targets
|
||||||
├── pyproject.toml # Python package configuration
|
├── pyproject.toml # Python package configuration
|
||||||
├── ProjectStatusDigest.md # This document
|
├── ProjectStatusDigest.md # This document
|
||||||
|
├── ProjectDiary.md # Development milestone tracking
|
||||||
└── README.md # Project overview
|
└── README.md # Project overview
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -112,12 +134,27 @@ markitect_project/
|
|||||||
|
|
||||||
2. **Development Workflow:**
|
2. **Development Workflow:**
|
||||||
```bash
|
```bash
|
||||||
make test # Run test suite
|
make test # Run comprehensive test suite (20+ tests)
|
||||||
make update # Pull latest changes from upstream
|
make update # Pull latest changes from upstream
|
||||||
make status # Check git status
|
make status # Check git status
|
||||||
```
|
```
|
||||||
|
|
||||||
3. **Building:**
|
3. **TDD Workflow:**
|
||||||
|
```bash
|
||||||
|
make tdd-start NUM=X # Start working on issue X
|
||||||
|
make tdd-add-test # Generate tests for current issue
|
||||||
|
make tdd-status # Check workspace status
|
||||||
|
make tdd-finish # Complete issue and integrate tests
|
||||||
|
```
|
||||||
|
|
||||||
|
4. **Issue Management:**
|
||||||
|
```bash
|
||||||
|
make list-issues # Show all Gitea issues
|
||||||
|
make list-open-issues # Show active backlog
|
||||||
|
make show-issue NUM=X # Detailed issue view
|
||||||
|
```
|
||||||
|
|
||||||
|
5. **Building:**
|
||||||
```bash
|
```bash
|
||||||
make build # Build the package
|
make build # Build the package
|
||||||
make clean # Clean build artifacts
|
make clean # Clean build artifacts
|
||||||
|
|||||||
Reference in New Issue
Block a user