|
|
--- |
|
|
title: Development Workflow |
|
|
description: Development processes, workflows, and automation for KGraph-MCP |
|
|
--- |
|
|
|
|
|
# Development Workflow |
|
|
|
|
|
Comprehensive documentation of development workflows, processes, and automation tools used in the KGraph-MCP project. |
|
|
|
|
|
## 🔄 **Workflow Sections** |
|
|
|
|
|
<div class="grid cards" markdown> |
|
|
|
|
|
- :material-cog:{ .lg .middle } **Development** |
|
|
|
|
|
--- |
|
|
|
|
|
Core development workflow and daily processes. |
|
|
|
|
|
[:octicons-arrow-right-24: Development Workflow](development.md) |
|
|
|
|
|
- :material-github:{ .lg .middle } **GitHub** |
|
|
|
|
|
--- |
|
|
|
|
|
Git workflows, GitHub integration, and project management. |
|
|
|
|
|
[:octicons-arrow-right-24: GitHub Workflow](github.md) |
|
|
|
|
|
- :material-hammer-wrench:{ .lg .middle } **Justfile** |
|
|
|
|
|
--- |
|
|
|
|
|
Task automation and command reference using Just. |
|
|
|
|
|
[:octicons-arrow-right-24: Justfile Reference](justfile.md) |
|
|
|
|
|
- :material-shield-check:{ .lg .middle } **Quality** |
|
|
|
|
|
--- |
|
|
|
|
|
Quality assurance processes and automated checks. |
|
|
|
|
|
[:octicons-arrow-right-24: Quality Assurance](quality.md) |
|
|
|
|
|
</div> |
|
|
|
|
|
<div class="grid cards" markdown> |
|
|
|
|
|
- :material-robot:{ .lg .middle } **Automation** |
|
|
|
|
|
--- |
|
|
|
|
|
Automated workflows, CI/CD, and continuous integration. |
|
|
|
|
|
[:octicons-arrow-right-24: Automation](automation.md) |
|
|
|
|
|
- :material-chef-hat:{ .lg .middle } **Recipe Taskmaster** |
|
|
|
|
|
--- |
|
|
|
|
|
Recipe Taskmaster workflow and task management integration. |
|
|
|
|
|
[:octicons-arrow-right-24: Recipe Taskmaster](recipe-taskmaster.md) |
|
|
|
|
|
</div> |
|
|
|
|
|
## 🚀 **Quick Workflow Overview** |
|
|
|
|
|
### **Daily Development Process** |
|
|
|
|
|
1. **Start Development** |
|
|
```bash |
|
|
just setup # First time setup |
|
|
just dev # Start development server |
|
|
``` |
|
|
|
|
|
2. **Code Quality** |
|
|
```bash |
|
|
just pre-commit # Run pre-commit checks |
|
|
just check # Full quality check |
|
|
``` |
|
|
|
|
|
3. **Testing** |
|
|
```bash |
|
|
just test # Run tests |
|
|
just test-cov # Run with coverage |
|
|
``` |
|
|
|
|
|
### **Task Management** |
|
|
|
|
|
1. **View Tasks** |
|
|
```bash |
|
|
just tasks # List all tasks |
|
|
just task-next # Get next task |
|
|
``` |
|
|
|
|
|
2. **Work on Task** |
|
|
```bash |
|
|
just task-start ID # Start task |
|
|
just task-done ID # Complete task |
|
|
``` |
|
|
|
|
|
3. **GitHub Sync** |
|
|
```bash |
|
|
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** |
|
|
```bash |
|
|
just setup # Complete environment setup |
|
|
just update # Update dependencies |
|
|
just clean # Clean generated files |
|
|
``` |
|
|
|
|
|
### **Development** |
|
|
```bash |
|
|
just dev # Development mode |
|
|
just run-app # Production mode |
|
|
just lint # Code linting |
|
|
just format # Code formatting |
|
|
``` |
|
|
|
|
|
### **Documentation** |
|
|
```bash |
|
|
just docs # Build documentation |
|
|
just docs-serve # Serve documentation |
|
|
just docs-deploy # Deploy to GitHub Pages |
|
|
``` |
|
|
|
|
|
## 📚 **Related Documentation** |
|
|
|
|
|
- [Developer Guide](../developer-guide/index.md) - Development setup and guidelines |
|
|
- [Task Management](../tasks/index.md) - Task tracking and execution |
|
|
- [Sprint Planning](../sprints/index.md) - Sprint management processes |
|
|
- [API Reference](../api/index.md) - API development guidelines |
