mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
41761f405c
## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
44 lines
1.5 KiB
Markdown
44 lines
1.5 KiB
Markdown
# SuperClaude Framework - Development Guide
|
|
|
|
## Build/Test/Lint Commands
|
|
```bash
|
|
# Install development dependencies
|
|
pip install -e ".[dev]"
|
|
|
|
# Code formatting (Black, 88 char line length)
|
|
black SuperClaude setup
|
|
|
|
# Linting
|
|
flake8 SuperClaude setup
|
|
|
|
# Type checking
|
|
mypy SuperClaude setup
|
|
|
|
# Run all quality checks
|
|
black . && flake8 SuperClaude setup && mypy SuperClaude setup
|
|
|
|
# Test installation (dry-run)
|
|
SuperClaude install --dry-run --verbose
|
|
|
|
# Build package
|
|
python -m build
|
|
|
|
# Validate PyPI readiness
|
|
python scripts/validate_pypi_ready.py
|
|
```
|
|
|
|
## Code Style Guidelines
|
|
- **Formatter**: Black (88 char lines), target Python 3.8-3.12
|
|
- **Imports**: Standard library → third-party → local (absolute imports preferred)
|
|
- **Type hints**: Required for all public functions using `typing` module
|
|
- **Naming**: PascalCase for classes, snake_case for functions/variables, UPPER_SNAKE_CASE for constants
|
|
- **Private methods**: Leading underscore (`_method_name`)
|
|
- **Docstrings**: Google style with Args/Returns/Raises sections
|
|
- **Error handling**: Use specific exceptions, log with `get_logger()`, display user messages with `display_*` functions
|
|
- **No comments**: Code should be self-documenting unless explicitly needed
|
|
|
|
## Project Structure
|
|
- `SuperClaude/`: Framework instruction files (Markdown-based AI prompts)
|
|
- `setup/`: Installation system (components, services, utils, CLI)
|
|
- `scripts/`: Build and publishing utilities
|
|
- Config files: `pyproject.toml` (main config), `setup.py` (legacy support) |