|
|
--- |
|
|
title: Developer Guide |
|
|
description: Comprehensive guide for KGraph-MCP contributors and advanced users |
|
|
--- |
|
|
|
|
|
# Developer Guide |
|
|
|
|
|
Welcome to the KGraph-MCP Developer Guide! This section contains detailed information for contributors, advanced users, and developers who want to extend or modify KGraph-MCP. |
|
|
|
|
|
## 🛠️ **Development Sections** |
|
|
|
|
|
<div class="grid cards" markdown> |
|
|
|
|
|
- :material-hammer-wrench:{ .lg .middle } **Setup** |
|
|
|
|
|
--- |
|
|
|
|
|
Complete development environment setup with all tools and dependencies. |
|
|
|
|
|
[:octicons-arrow-right-24: Development Setup](setup.md) |
|
|
|
|
|
- :material-source-pull:{ .lg .middle } **Contributing** |
|
|
|
|
|
--- |
|
|
|
|
|
Guidelines for contributing code, documentation, and reporting issues. |
|
|
|
|
|
[:octicons-arrow-right-24: Contributing Guide](contributing.md) |
|
|
|
|
|
- :material-code-tags:{ .lg .middle } **Code Style** |
|
|
|
|
|
--- |
|
|
|
|
|
Coding standards, linting rules, and best practices for the project. |
|
|
|
|
|
[:octicons-arrow-right-24: Code Style](code-style.md) |
|
|
|
|
|
- :material-flask:{ .lg .middle } **Testing** |
|
|
|
|
|
--- |
|
|
|
|
|
Testing strategies, frameworks, and guidelines for maintaining quality. |
|
|
|
|
|
[:octicons-arrow-right-24: Testing Guide](testing.md) |
|
|
|
|
|
</div> |
|
|
|
|
|
## 🏗️ **Development Workflow** |
|
|
|
|
|
For contributors and maintainers, follow this development workflow: |
|
|
|
|
|
1. **[Setup](setup.md)** - Configure your development environment |
|
|
2. **[Code Style](code-style.md)** - Follow project coding standards |
|
|
3. **[Testing](testing.md)** - Write and run comprehensive tests |
|
|
4. **[Contributing](contributing.md)** - Submit your contributions |
|
|
|
|
|
## 🔧 **Quick Development Commands** |
|
|
|
|
|
```bash |
|
|
# Setup development environment |
|
|
just setup |
|
|
|
|
|
# Run in development mode |
|
|
just dev |
|
|
|
|
|
# Run all quality checks |
|
|
just check |
|
|
|
|
|
# Run tests with coverage |
|
|
just test-cov |
|
|
|
|
|
# Run pre-commit checks |
|
|
just pre-commit |
|
|
``` |
|
|
|
|
|
## 📋 **Development Standards** |
|
|
|
|
|
- **Python 3.11.8+** - Required Python version |
|
|
- **Test-Driven Development** - Write tests first |
|
|
- **Type Safety** - Full type annotations with mypy |
|
|
- **Code Quality** - Black formatting + Ruff linting |
|
|
- **Documentation** - Comprehensive docstrings and guides |
|
|
|
|
|
## 🔗 **Related Resources** |
|
|
|
|
|
- [Architecture Overview](../architecture/index.md) - System design and components |
|
|
- [API Documentation](../api/index.md) - Complete API reference |
|
|
- [Quality Assurance](../workflow/quality.md) - QA processes and tools |
|
|
- [GitHub Workflow](../workflow/github.md) - Git and GitHub processes |
