mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
refactor(docs): normalize documentation naming to lowercase for PEP8 compliance (#434)
* refactor(docs): rename directories to lowercase for PEP8 compliance - Developer-Guide → developer-guide - Getting-Started → getting-started - Reference → reference - Templates → templates - User-Guide → user-guide - User-Guide-jp → user-guide-jp - User-Guide-kr → user-guide-kr - User-Guide-zh → user-guide-zh This change aligns with Python PEP8 package naming conventions. All 43 files affected. * refactor: rename root documentation files to lowercase - CHANGELOG.md → changelog.md - CODE_OF_CONDUCT.md → code_of_conduct.md - CONTRIBUTING.md → contributing.md - SECURITY.md → security.md Aligns with Python package naming conventions (PEP8). README files remain uppercase as per convention. * refactor: move documentation files to docs/ for cleaner root Moved OSS standard files to docs/: - CHANGELOG.md → docs/CHANGELOG.md - CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md - CONTRIBUTING.md → docs/CONTRIBUTING.md - SECURITY.md → docs/SECURITY.md Root now contains only essential files: ✓ README files (表紙: en, ja, kr, zh) ✓ LICENSE (法的要件) ✓ Build configs (pyproject.toml, setup.py, MANIFEST.in) ✓ VERSION Rationale: Cleaner root structure following modern Python project conventions. All detailed documentation consolidated in docs/ directory. * refactor: update documentation links after restructure Auto-updated internal documentation links to reflect new structure: - docs/ subdirectories now lowercase (PEP8) - Root files moved to docs/ - All cross-references updated This commit includes linter-generated link updates. * chore(docs): keep OSS-standard uppercase root files (CHANGELOG, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY) * chore(docs): remove duplicated PR docs from repo root (moved under docs) * docs: rename pm-agent-implementation-status.md -> PM_AGENT.md for clarity * docs: update links to PM_AGENT.md after rename --------- Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>
This commit is contained in:
kazuki nakai
@@ -1,319 +0,0 @@
|
||||
# SuperClaude Integration Patterns Collection
|
||||
|
||||
**Status**: ✅ **Status: Current** - Context patterns for framework integration and tool coordination.
|
||||
|
||||
**Context Integration Guide**: Patterns for using SuperClaude commands effectively with different frameworks and tools. Remember: SuperClaude provides context to Claude Code - all actual work is done by Claude.
|
||||
|
||||
## Overview and Usage Guide
|
||||
|
||||
**Purpose**: Effective patterns for using SuperClaude context with various development frameworks and tools.
|
||||
|
||||
**What This Is**: Command combinations and flag patterns that work well for specific technologies
|
||||
**What This Isn't**: Performance optimization or parallel execution (no code runs)
|
||||
|
||||
**Key Principle**: SuperClaude tells Claude Code WHAT to do and HOW to think about it. Claude Code does the actual work.
|
||||
|
||||
## Framework Context Patterns
|
||||
|
||||
### React Development Patterns
|
||||
|
||||
```bash
|
||||
# React development with appropriate context
|
||||
/sc:implement "React 18 application with TypeScript" --c7
|
||||
# Context7 MCP can provide React documentation if available
|
||||
# Magic MCP can help with UI components if configured
|
||||
|
||||
# What Actually Happens:
|
||||
# 1. Claude reads implement.md for implementation patterns
|
||||
# 2. --c7 flag suggests using Context7 MCP for documentation
|
||||
# 3. Claude generates React code based on these contexts
|
||||
|
||||
# Component development pattern
|
||||
@agent-frontend-architect "design component architecture"
|
||||
/sc:implement "reusable component library"
|
||||
|
||||
# Testing pattern for React
|
||||
/sc:test --focus react
|
||||
# Claude will suggest React Testing Library patterns
|
||||
```
|
||||
|
||||
### Node.js Backend Patterns
|
||||
|
||||
```bash
|
||||
# Node.js backend development patterns
|
||||
/sc:implement "Express.js API with TypeScript" --c7
|
||||
# Claude will create Express API following Node.js patterns
|
||||
|
||||
# What This Means:
|
||||
# - Claude reads context about backend patterns
|
||||
# - Suggests appropriate middleware and structure
|
||||
# - NOT running or optimizing any code
|
||||
|
||||
# Database integration pattern
|
||||
/sc:implement "database models with Prisma"
|
||||
@agent-backend-architect "review database schema"
|
||||
|
||||
# API testing pattern
|
||||
/sc:test --focus api
|
||||
# Claude suggests API testing approaches
|
||||
```
|
||||
|
||||
### Python Development Patterns
|
||||
|
||||
```bash
|
||||
# Python web development
|
||||
/sc:implement "FastAPI application" --c7
|
||||
@agent-python-expert "review implementation"
|
||||
|
||||
# What Happens:
|
||||
# - Claude uses Python-specific context
|
||||
# - Follows FastAPI patterns from context
|
||||
# - Generates code (doesn't run it)
|
||||
|
||||
# Data science context
|
||||
/sc:implement "data analysis pipeline"
|
||||
@agent-python-expert "optimize pandas operations"
|
||||
# Claude provides optimization suggestions (not actual optimization)
|
||||
|
||||
# Testing patterns
|
||||
/sc:test --focus python
|
||||
# Claude suggests pytest patterns
|
||||
```
|
||||
|
||||
### Full-Stack Development Patterns
|
||||
|
||||
```bash
|
||||
# Full-stack application pattern
|
||||
/sc:brainstorm "full-stack application architecture"
|
||||
@agent-system-architect "design system components"
|
||||
|
||||
# Frontend implementation
|
||||
/sc:implement "React frontend with TypeScript"
|
||||
@agent-frontend-architect "review component structure"
|
||||
|
||||
# Backend implementation
|
||||
/sc:implement "Node.js API with authentication"
|
||||
@agent-backend-architect "review API design"
|
||||
|
||||
# Integration
|
||||
/sc:implement "connect frontend to backend API"
|
||||
```
|
||||
|
||||
## Tool Coordination Patterns
|
||||
|
||||
### Using MCP Servers Effectively
|
||||
|
||||
```bash
|
||||
# Context7 for documentation
|
||||
/sc:explain "React hooks" --c7
|
||||
# If Context7 is configured, it may fetch React docs
|
||||
|
||||
# Sequential for complex reasoning
|
||||
/sc:troubleshoot "complex bug" --seq
|
||||
# Sequential MCP helps with structured problem-solving
|
||||
|
||||
# Magic for UI components
|
||||
/sc:implement "UI components" --magic
|
||||
# Magic MCP can help generate modern UI patterns
|
||||
|
||||
# No MCP for simple tasks
|
||||
/sc:implement "utility function" --no-mcp
|
||||
# Uses only Claude's built-in knowledge
|
||||
```
|
||||
|
||||
### Agent and Command Combinations
|
||||
|
||||
```bash
|
||||
# Security-focused development
|
||||
@agent-security "review authentication requirements"
|
||||
/sc:implement "secure authentication system"
|
||||
/sc:analyze --focus security
|
||||
|
||||
# Quality-focused workflow
|
||||
/sc:implement "new feature"
|
||||
@agent-quality-engineer "review code quality"
|
||||
/sc:test --focus quality
|
||||
|
||||
# Architecture-focused approach
|
||||
@agent-system-architect "design microservices"
|
||||
/sc:design "service boundaries"
|
||||
/sc:implement "service communication"
|
||||
```
|
||||
|
||||
## Common Integration Patterns
|
||||
|
||||
### API Development Pattern
|
||||
|
||||
```bash
|
||||
# Step 1: Design
|
||||
/sc:design "REST API structure"
|
||||
|
||||
# Step 2: Implementation
|
||||
/sc:implement "API endpoints with validation"
|
||||
|
||||
# Step 3: Documentation
|
||||
/sc:document --type api
|
||||
|
||||
# Step 4: Testing
|
||||
/sc:test --focus api
|
||||
```
|
||||
|
||||
### Database Integration Pattern
|
||||
|
||||
```bash
|
||||
# Schema design
|
||||
@agent-backend-architect "design database schema"
|
||||
|
||||
# Model implementation
|
||||
/sc:implement "database models"
|
||||
|
||||
# Migration creation
|
||||
/sc:implement "database migrations"
|
||||
|
||||
# Query optimization suggestions
|
||||
@agent-backend-architect "suggest query optimizations"
|
||||
# Note: Claude suggests optimizations, doesn't actually optimize
|
||||
```
|
||||
|
||||
### Testing Strategy Pattern
|
||||
|
||||
```bash
|
||||
# Test planning
|
||||
/sc:design "testing strategy"
|
||||
|
||||
# Unit tests
|
||||
/sc:test --type unit
|
||||
|
||||
# Integration tests
|
||||
/sc:test --type integration
|
||||
|
||||
# E2E test suggestions
|
||||
/sc:test --type e2e
|
||||
# Claude provides test code, not execution
|
||||
```
|
||||
|
||||
## Technology-Specific Patterns
|
||||
|
||||
### React + TypeScript Pattern
|
||||
|
||||
```bash
|
||||
# Project setup guidance
|
||||
/sc:implement "React TypeScript project structure"
|
||||
|
||||
# Component development
|
||||
/sc:implement "TypeScript React components with props validation"
|
||||
|
||||
# State management
|
||||
@agent-frontend-architect "recommend state management approach"
|
||||
/sc:implement "state management with Zustand/Redux"
|
||||
|
||||
# Testing
|
||||
/sc:test --focus react --type unit
|
||||
```
|
||||
|
||||
### Python FastAPI Pattern
|
||||
|
||||
```bash
|
||||
# API structure
|
||||
/sc:implement "FastAPI project structure"
|
||||
|
||||
# Endpoint development
|
||||
@agent-python-expert "implement async endpoints"
|
||||
|
||||
# Database integration
|
||||
/sc:implement "SQLAlchemy models with Alembic"
|
||||
|
||||
# Testing
|
||||
/sc:test --focus python --type integration
|
||||
```
|
||||
|
||||
### Node.js Microservices Pattern
|
||||
|
||||
```bash
|
||||
# Architecture design
|
||||
@agent-system-architect "design microservices architecture"
|
||||
|
||||
# Service implementation
|
||||
/sc:implement "user service with Express"
|
||||
/sc:implement "auth service with JWT"
|
||||
|
||||
# Inter-service communication
|
||||
/sc:implement "service communication patterns"
|
||||
|
||||
# Testing approach
|
||||
/sc:test --focus microservices
|
||||
```
|
||||
|
||||
## Troubleshooting Patterns
|
||||
|
||||
### Debugging Workflow
|
||||
|
||||
```bash
|
||||
# Problem analysis
|
||||
/sc:troubleshoot "describe the issue"
|
||||
|
||||
# Root cause investigation
|
||||
@agent-root-cause-analyst "analyze symptoms"
|
||||
|
||||
# Solution implementation
|
||||
/sc:implement "fix based on analysis"
|
||||
|
||||
# Verification
|
||||
/sc:test --validate
|
||||
```
|
||||
|
||||
### Code Review Pattern
|
||||
|
||||
```bash
|
||||
# Code analysis
|
||||
/sc:analyze code/ --focus quality
|
||||
|
||||
# Security review
|
||||
@agent-security "review for vulnerabilities"
|
||||
|
||||
# Performance review
|
||||
@agent-performance-engineer "suggest improvements"
|
||||
# Note: Suggestions only, no actual performance measurement
|
||||
|
||||
# Implementation of improvements
|
||||
/sc:improve code/ --fix
|
||||
```
|
||||
|
||||
## Important Clarifications
|
||||
|
||||
### What These Patterns DO
|
||||
|
||||
- ✅ Provide structured approaches to development tasks
|
||||
- ✅ Combine commands and agents effectively
|
||||
- ✅ Suggest appropriate tools and frameworks
|
||||
- ✅ Guide Claude to generate better code
|
||||
|
||||
### What These Patterns DON'T DO
|
||||
|
||||
- ❌ Execute code or measure performance
|
||||
- ❌ Run tests or deploy applications
|
||||
- ❌ Optimize actual execution speed
|
||||
- ❌ Provide real monitoring or metrics
|
||||
- ❌ Coordinate parallel processes (everything is sequential text)
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Effective Pattern Usage
|
||||
|
||||
1. **Start with context**: Use `/sc:load` to establish project understanding
|
||||
2. **Layer expertise**: Combine general commands with specific agents
|
||||
3. **Focus appropriately**: Use `--focus` flags for targeted results
|
||||
4. **Manage scope**: Work on specific modules rather than entire codebases
|
||||
5. **Document decisions**: Use `/sc:save` to create summaries
|
||||
|
||||
### Pattern Selection
|
||||
|
||||
- **Simple tasks**: Use basic commands without MCP
|
||||
- **Complex tasks**: Add appropriate agents and MCP servers
|
||||
- **Security-critical**: Always include `@agent-security`
|
||||
- **UI development**: Consider `--magic` flag if configured
|
||||
- **Documentation needs**: Use `--c7` for framework docs
|
||||
|
||||
## Summary
|
||||
|
||||
These integration patterns show how to combine SuperClaude commands, agents, and flags effectively for different development scenarios. Remember that all patterns are about providing better context to Claude Code - the actual code generation, not execution, is what Claude does based on these contexts.
|
||||
Reference in New Issue
Block a user