Development Workflow¶

Comprehensive documentation of development workflows, processes, and automation tools used in the KGraph-MCP project.

🔄 Workflow Sections¶

🚀 Quick Workflow Overview¶

Daily Development Process¶

1. Start Development

   just setup        # First time setup
   just dev         # Start development server
   

2. Code Quality

   just pre-commit  # Run pre-commit checks
   just check       # Full quality check
   

3. Testing

   just test        # Run tests
   just test-cov    # Run with coverage
   

Task Management¶

1. View Tasks

   just tasks       # List all tasks
   just task-next   # Get next task
   

2. Work on Task

   just task-start ID    # Start task
   just task-done ID     # Complete task
   

3. GitHub Sync

   just gh-sync-all      # Sync all to GitHub
   just gh-project-view  # Open project board
   

🎯 Workflow Principles¶

Our development workflow is built on these principles:

Automation First¶

• Automated quality checks
• Continuous integration
• Automated deployment
• Self-documenting processes

Quality Gates¶

• Code formatting with Black
• Linting with Ruff
• Type checking with mypy
• Comprehensive testing

Transparency¶

• Real-time project tracking
• Automated progress reports
• Public documentation
• Open development process

🔧 Development Tools¶

Core Tools¶

• uv - Python package management
• Just - Task automation
• Black - Code formatting
• Ruff - Fast Python linter
• mypy - Type checking
• pytest - Testing framework

Project Management¶

• GitHub Projects - Project tracking
• Recipe Taskmaster - Intelligent task management
• Automated reporting - Progress tracking
• Documentation - MkDocs integration

Quality Assurance¶

• Pre-commit hooks - Automated checks
• Continuous testing - Test automation
• Code coverage - Quality metrics
• Security scanning - Vulnerability detection

📋 Workflow Commands¶

Environment Management¶

just setup        # Complete environment setup
just update       # Update dependencies
just clean        # Clean generated files

Development¶

just dev          # Development mode
just run-app      # Production mode
just lint         # Code linting
just format       # Code formatting

Documentation¶

just docs         # Build documentation
just docs-serve   # Serve documentation
just docs-deploy  # Deploy to GitHub Pages

📚 Related Documentation¶

• Developer Guide - Development setup and guidelines
• Task Management - Task tracking and execution
• Sprint Planning - Sprint management processes
• API Reference - API development guidelines