smart-commit-cli 0.1.0__tar.gz

smart_commit_cli-0.1.0/.env.example

@@ -0,0 +1,12 @@
+# LLM Configuration
+SMART_COMMIT_PROVIDER=openrouter
+SMART_COMMIT_MODEL=anthropic/claude-sonnet
+SMART_COMMIT_API_KEY=your-api-key-here
+
+# Optional: Embedding Model
+# SMART_COMMIT_EMBEDDING_MODEL=all-MiniLM-L6-v2
+
+# Optional: Behavior
+# SMART_COMMIT_INTERACTIVE=true
+# SMART_COMMIT_AUTO_PUSH=false
+# SMART_COMMIT_CONVENTIONAL_COMMITS=true

smart_commit_cli-0.1.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

smart_commit_cli-0.1.0/.smart_commit_cache/cache.json

@@ -0,0 +1 @@
+{"summaries_f7707885b44d20743f040267e0d7dfb4": "Added _extract_js_functions. Introduced dependencies on import tree_sitter_javascript as ts_js, import tree_sitter.", "summaries_38c82d20a03c5c23c011ec7b980b9c32": "Introduced dependencies on from ..cache import cache_manager.", "summaries_19dbd2b0784c9333dd2e15c9887c134e": "Added command_benchmark. Introduced dependencies on from .preview import PreviewRenderer, InteractiveEditor, from ric...", "summaries_9fdcbae5302c84770ce2fa1542dedbb3": "Added _generate_reason.", "summaries_21b5c866caccdc3b0cb852b01b6caee2": "Introduced dependencies on from ..cache import cache_manager.", "summaries_a3f82fe7357e6a66d247221408f03572": "Removed _check_symbol_overlap, _check_import_overlap, _filename_similarity. Introduced dependencies on from typing im...", "summaries_26608a8e89bb53e7eb0d602cd4bd5d38": "Added SymbolExtraction.", "summaries_1fed4521e7148f507c5d5b3754c4c7df": "Removed get_commit_hints, should_group_files, get_ignored_files. Introduced dependencies on from .django import Djang...", "summaries_3ad48235cc842c941fc3dd5652897e4a": "Introduced dependencies on editor, from .editor import InteractiveEditor.", "summaries_884708e8befad05a8f1bdd2af24d0681": "Removed get_confirmation, edit_messages.", "summaries_46b37c32018786696e440af3acde1904": "Added __init__, SymbolExtractor, extract_symbols. Introduced dependencies on from ..models import FileDiff, SymbolExt...", "summaries_8cf0e55c6fa9911533b4edb367e9714c": "Added BenchmarkHarness, __init__, run. Introduced dependencies on pathlib, import time, from rich.table import Table.", "summaries_ee7eb86c1e08e80c2d4206d6e804bd13": "Added _save_cache, __init__, set and more. Introduced dependencies on import hashlib, pathlib, hashlib.", "summaries_064200f53ebaecc9706b88b7d11f731f": "Added get_commit_hints, DjangoPlugin, get_ignored_files. Introduced dependencies on from .base import Plugin, models,...", "summaries_33ae44914ed1b80b157c3abec6e05775": "Added get_commit_hints, FastAPIPlugin, get_ignored_files. Introduced dependencies on from .base import Plugin, models...", "summaries_3cdb1e4acac84ec15485964c7d3d32fc": "Added get_commit_hints, ReactPlugin, should_group_files and more. Introduced dependencies on from .base import Plugin...", "summaries_0293e572a27e36cdd97473558cb160c5": "Added InteractiveEditor, _action_delete, __init__ and more. Introduced dependencies on uuid, from .renderer import Pr...", "summaries_1cf2566b79cab33f4d50464f4b159119": "Added new content", "summaries_274a78a8c939c5b5a438d03a82704fd1": "Added test. Introduced dependencies on import os, networkx, os.", "dependency_graph_77928d4edaed701f6e3835d1b6d2292c": [["smart_commit/execution/committer.py", "utils"], ["smart_commit/clustering/__init__.py", "heuristic"], ["smart_commit/cli.py", "git"], ["smart_commit/utils.py", "os"], ["smart_commit/config.py", "typing"], ["dummy_file.py", "networkx"], ["smart_commit/utils.py", "typing"], ["smart_commit/plugins/base.py", "react"], ["smart_commit/preview/renderer.py", "constants"], ["smart_commit/git/service.py", "models"], ["tests/test_git_service.py", "smart_commit.git_service"], ["smart_commit/benchmark.py", "pathlib"], ["smart_commit/embeddings/similarity.py", "logger"], ["smart_commit/ai/reviewer.py", "logger"], ["smart_commit/ai/client.py", "re"], ["smart_commit/logger.py", "typing"], ["smart_commit/embeddings/generator.py", "logger"], ["smart_commit/embeddings/__init__.py", "similarity"], ["smart_commit/git_service.py", "git.exc"], ["smart_commit/analysis/summarizer.py", "models"], ["smart_commit/clustering/graph_clustering.py", "models"], ["smart_commit/plugins/django.py", "typing"], ["smart_commit/benchmark.py", "git"], ["smart_commit/diff_parser.py", "re"], ["smart_commit/clustering/graph_clustering.py", "numpy"], ["smart_commit/embeddings/similarity.py", "analysis.dependency_graph"], ["smart_commit/preview/editor.py", "rich.console"], ["smart_commit/analysis/summarizer.py", "diff_parser"], ["smart_commit/preview/renderer.py", "rich.table"], ["smart_commit/clustering/semantic.py", "analysis.dependency_graph"], ["smart_commit/preview/editor.py", "typing"], ["smart_commit/git/service.py", "subprocess"], ["smart_commit/utils.py", "sys"], ["smart_commit/plugins/base.py", "logger"], ["tests/test_commit_messages.py", "pytest"], ["smart_commit/plugins/fastapi.py", "base"], ["smart_commit/benchmark.py", "time"], ["smart_commit/logger.py", "sys"], ["smart_commit/preview/renderer.py", "rich.panel"], ["smart_commit/committer.py", "models"], ["smart_commit/cache.py", "logger"], ["smart_commit/config.py", "pathlib"], ["smart_commit/utils.py", "pathlib"], ["smart_commit/git_service.py", "models"], ["smart_commit/git/__init__.py", "scanner"], ["smart_commit/analysis/symbol_extractor.py", "models"], ["smart_commit/preview/__init__.py", "editor"], ["smart_commit/plugins/django.py", "base"], ["smart_commit/logger.py", "pathlib"], ["smart_commit/clustering/heuristic.py", "logger"], ["smart_commit/diff_parser.py", "models"], ["smart_commit/preview/renderer.py", "models"], ["smart_commit/commit_messages.py", "config"], ["smart_commit/git/safety.py", "exceptions"], ["smart_commit/git/__init__.py", "service"], ["smart_commit/clustering/semantic.py", "embeddings"], ["tests/test_git_service.py", "pathlib"], ["smart_commit/cli.py", "exceptions"], ["smart_commit/preview.py", "rich.table"], ["smart_commit/git/scanner.py", "exceptions"], ["tests/test_git_service.py", "git"], ["smart_commit/config.py", "yaml"], ["smart_commit/clustering.py", "sklearn.cluster"], ["dummy_file.py", "os"], ["smart_commit/embeddings/similarity.py", "typing"], ["smart_commit/plugins/react.py", "models"], ["smart_commit/ai/reviewer.py", "typing"], ["smart_commit/analysis/__init__.py", "diff_parser"], ["smart_commit/clustering/graph_clustering.py", "networkx"], ["smart_commit/cli.py", "config"], ["smart_commit/cli.py", "rich.progress"], ["smart_commit/clustering/semantic.py", "typing"], ["tests/test_commit_messages.py", "smart_commit.models"], ["smart_commit/clustering.py", "models"], ["smart_commit/clustering.py", "numpy"], ["smart_commit/logger.py", "logging"], ["smart_commit/committer.py", "git_service"], ["smart_commit/cli.py", "plugins"], ["smart_commit/ai/client.py", "typing"], ["smart_commit/plugins/base.py", "fastapi"], ["smart_commit/analysis/symbol_extractor.py", "typing"], ["smart_commit/embeddings/generator.py", "cache"], ["smart_commit/plugins/base.py", "typing"], ["smart_commit/diff_parser.py", "typing"], ["smart_commit/preview.py", "models"], ["tests/test_git_service.py", "pytest"], ["smart_commit/analysis/ast_parser.py", "tree_sitter"], ["smart_commit/clustering/semantic.py", "logger"], ["smart_commit/ai/reviewer.py", "client"], ["smart_commit/cache.py", "typing"], ["smart_commit/cli.py", "constants"], ["smart_commit/ai/client.py", "constants"], ["smart_commit/ai/client.py", "logger"], ["smart_commit/analysis/symbol_extractor.py", "logger"], ["smart_commit/plugins/fastapi.py", "models"], ["smart_commit/constants.py", "pathlib"], ["smart_commit/ai/reviewer.py", "json"], ["smart_commit/clustering/semantic.py", "pathlib"], ["smart_commit/ai/__init__.py", "client"], ["smart_commit/analysis/symbol_extractor.py", "ast_parser"], ["smart_commit/ai.py", "json"], ["smart_commit/analysis/dependency_graph.py", "os"], ["smart_commit/analysis/dependency_graph.py", "typing"], ["smart_commit/ai.py", "litellm"], ["smart_commit/utils.py", "json"], ["smart_commit/plugins/base.py", "pathlib"], ["smart_commit/commit_messages.py", "models"], ["smart_commit/git/__init__.py", "safety"], ["smart_commit/git/service.py", "typing"], ["smart_commit/preview/renderer.py", "rich.tree"], ["smart_commit/plugins/__init__.py", "base"], ["smart_commit/benchmark.py", "rich.table"], ["smart_commit/models.py", "enum"], ["smart_commit/clustering/semantic.py", "graph_clustering"], ["smart_commit/git/service.py", "scanner"], ["smart_commit/cache.py", "pathlib"], ["smart_commit/clustering/graph_clustering.py", "typing"], ["smart_commit/analysis/dependency_graph.py", "logger"], ["smart_commit/execution/committer.py", "models"], ["smart_commit/clustering/__init__.py", "semantic"], ["smart_commit/clustering/graph_clustering.py", "networkx.algorithms.community"], ["smart_commit/cli.py", "analysis"], ["smart_commit/models.py", "dataclasses"], ["smart_commit/cli.py", "models"], ["smart_commit/analysis/dependency_graph.py", "ast_parser"], ["smart_commit/git/service.py", "logger"], ["smart_commit/analysis/diff_parser.py", "re"], ["smart_commit/git/scanner.py", "models"], ["tests/test_clustering.py", "pytest"], ["smart_commit/summarizer.py", "diff_parser"], ["smart_commit/utils.py", "datetime"], ["smart_commit/analysis/dependency_graph.py", "pathlib"], ["smart_commit/preview.py", "rich.panel"], ["smart_commit/committer.py", "typing"], ["smart_commit/analysis/summarizer.py", "logger"], ["smart_commit/clustering/graph_clustering.py", "logger"], ["smart_commit/preview/editor.py", "rich.prompt"], ["smart_commit/benchmark.py", "analysis"], ["smart_commit/logger.py", "datetime"], ["smart_commit/preview/editor.py", "renderer"], ["smart_commit/commit_messages.py", "typing"], ["smart_commit/git_service.py", "typing"], ["smart_commit/git/service.py", "pathlib"], ["smart_commit/preview/renderer.py", "rich.console"], ["smart_commit/git/scanner.py", "subprocess"], ["smart_commit/cli.py", "analysis.symbol_extractor"], ["tests/test_diff_parser.py", "smart_commit.diff_parser"], ["smart_commit/embeddings/generator.py", "models"], ["smart_commit/clustering.py", "embeddings"], ["smart_commit/embeddings/generator.py", "numpy"], ["smart_commit/execution/__init__.py", "committer"], ["smart_commit/plugins/base.py", "django"], ["tests/test_commit_messages.py", "smart_commit.commit_messages"], ["smart_commit/analysis/diff_parser.py", "models"], ["tests/test_git_service.py", "git.exc"], ["smart_commit/git/scanner.py", "dataclasses"], ["smart_commit/benchmark.py", "analysis.symbol_extractor"], ["smart_commit/git/scanner.py", "constants"], ["smart_commit/cli.py", "execution"], ["smart_commit/plugins/react.py", "typing"], ["smart_commit/committer.py", "pathlib"], ["smart_commit/ai.py", "config"], ["smart_commit/embeddings.py", "models"], ["smart_commit/cli.py", "clustering"], ["smart_commit/embeddings.py", "numpy"], ["smart_commit/utils.py", "hashlib"], ["smart_commit/clustering.py", "typing"], ["tests/test_diff_parser.py", "pytest"], ["tests/test_clustering.py", "smart_commit.models"], ["smart_commit/ai/client.py", "json"], ["smart_commit/git_service.py", "pathlib"], ["smart_commit/execution/committer.py", "logger"], ["smart_commit/analysis/ast_parser.py", "tree_sitter_javascript"], ["smart_commit/git/safety.py", "logger"], ["smart_commit/plugins/django.py", "models"], ["smart_commit/cli.py", "sys"], ["smart_commit/cli.py", "logger"], ["smart_commit/preview.py", "rich.console"], ["smart_commit/ai/client.py", "litellm"], ["smart_commit/git_service.py", "git"], ["smart_commit/ai/__init__.py", "reviewer"], ["smart_commit/benchmark.py", "clustering"], ["smart_commit/cli.py", "commit_messages"], ["smart_commit/utils.py", "uuid"], ["smart_commit/preview/editor.py", "models"], ["smart_commit/preview.py", "typing"], ["smart_commit/analysis/dependency_graph.py", "cache"], ["smart_commit/embeddings/similarity.py", "constants"], ["smart_commit/clustering/heuristic.py", "models"], ["smart_commit/embeddings/generator.py", "constants"], ["smart_commit/cache.py", "json"], ["smart_commit/embeddings/similarity.py", "generator"], ["smart_commit/ai/client.py", "time"], ["smart_commit/plugins/react.py", "base"], ["smart_commit/embeddings.py", "sentence_transformers"], ["smart_commit/clustering/semantic.py", "heuristic"], ["smart_commit/plugins/fastapi.py", "typing"], ["smart_commit/config.py", "dataclasses"], ["smart_commit/preview/editor.py", "uuid"], ["smart_commit/summarizer.py", "models"], ["smart_commit/analysis/summarizer.py", "cache"], ["smart_commit/config.py", "os"], ["smart_commit/benchmark.py", "analysis.dependency_graph"], ["smart_commit/models.py", "typing"], ["smart_commit/embeddings.py", "typing"], ["smart_commit/logger.py", "constants"], ["smart_commit/analysis/ast_parser.py", "typing"], ["smart_commit/cli.py", "argparse"], ["smart_commit/analysis/ast_parser.py", "ast"], ["smart_commit/embeddings/__init__.py", "generator"], ["smart_commit/analysis/diff_parser.py", "logger"], ["smart_commit/analysis/__init__.py", "summarizer"], ["smart_commit/clustering/semantic.py", "sklearn.cluster"], ["smart_commit/analysis/ast_parser.py", "logger"], ["smart_commit/embeddings/similarity.py", "models"], ["smart_commit/git/service.py", "utils"], ["smart_commit/ai/reviewer.py", "models"], ["smart_commit/embeddings/similarity.py", "numpy"], ["smart_commit/git/safety.py", "typing"], ["smart_commit/clustering/semantic.py", "models"], ["smart_commit/clustering/semantic.py", "numpy"], ["smart_commit/ai/client.py", "exceptions"], ["smart_commit/ai.py", "models"], ["smart_commit/cli.py", "typing"], ["smart_commit/summarizer.py", "typing"], ["smart_commit/git/scanner.py", "typing"], ["smart_commit/plugins/base.py", "models"], ["smart_commit/benchmark.py", "rich.console"], ["smart_commit/cli.py", "preview"], ["smart_commit/analysis/symbol_extractor.py", "diff_parser"], ["smart_commit/ai/client.py", "config"], ["smart_commit/constants.py", "enum"], ["tests/test_clustering.py", "smart_commit.clustering"], ["smart_commit/analysis/dependency_graph.py", "networkx"], ["smart_commit/cli.py", "benchmark"], ["smart_commit/cache.py", "hashlib"], ["smart_commit/committer.py", "utils"], ["smart_commit/config.py", "dotenv"], ["smart_commit/embeddings/generator.py", "sentence_transformers"], ["smart_commit/embeddings/similarity.py", "dataclasses"], ["smart_commit/preview/__init__.py", "renderer"], ["smart_commit/git_service.py", "utils"], ["smart_commit/plugins/base.py", "abc"], ["smart_commit/git/safety.py", "pathlib"], ["smart_commit/clustering/semantic.py", "constants"], ["smart_commit/embeddings/generator.py", "typing"], ["smart_commit/cli.py", "pathlib"], ["smart_commit/cli.py", "ai"], ["smart_commit/execution/committer.py", "git"], ["smart_commit/ai.py", "typing"], ["smart_commit/git/scanner.py", "pathlib"]], "summaries_943f2588ea9722c748559a67cc995b24": "Modified file", "summaries_07aee2946b00c8a027fe803f7fafa791": "Modified content"}

smart_commit_cli-0.1.0/CHANGELOG.md

@@ -0,0 +1,154 @@
+# Changelog
+
+All notable changes to Smart Commit are documented in this file.
+
+## [0.2.0] - 2026-01-10 - v2 Architecture
+
+### Added
+
+#### Core Infrastructure
+- **constants.py**: Configuration constants, enums for various states
+- **exceptions.py**: Comprehensive exception hierarchy (15+ exception types)
+- **logger.py**: Color-coded logging with session support
+
+#### Architecture Reorganization
+- **git/** package: Repository scanning, git operations, and safety checks
+  - `scanner.py`: RepositoryScanner for repository state analysis
+  - `service.py`: Refactored GitService with improved session management
+  - `safety.py`: SafetyChecker for pre-execution validation
+  
+- **analysis/** package: Enhanced code analysis
+  - `diff_parser.py`: Improved diff parser with language-specific symbol extraction
+  - `summarizer.py`: Conc ise summary generation (20-80 words)
+  - `ast_parser.py`: AST parsing for Python (foundation for other languages)
+  
+- **embeddings/** package: Semantic embeddings
+  - `generator.py`: EmbeddingsGenerator using SentenceTransformers
+  - `similarity.py`: SimilarityGraph with weighted multi-factor similarity
+  
+- **clustering/** package: File grouping algorithms
+  - `semantic.py`: ML-based clustering with Agglomerative and greedy fallback
+  - `heuristic.py`: Rule-based clustering by directory and file type
+  
+- **ai/** package: LLM integration
+  - `client.py`: LiteLLM wrapper with retry logic and error handling
+  - `reviewer.py`: ClusterReviewer for LLM-based cluster analysis
+  
+- **preview/** package: User interface
+  - `renderer.py`: Rich-based terminal UI with panels, trees, tables
+  
+- **execution/** package: Commit execution
+  - `committer.py`: Safe commit creation with dry-run support
+  
+- **plugins/** package: Extensible plugin system
+  - `base.py`: Plugin base class and registry
+  - Built-in: ReactPlugin, DjangoPlugin
+
+#### Enhanced CLI
+- New command: `smart-commit plugins`
+- New options: `--yes`, `--dry-run`, `--offline`, `--no-ai`
+- Model and provider overrides in CLI
+- Full 7-step pipeline visualization
+- Interactive preview with confirmation
+
+#### Safety & Quality
+- SafetyChecker validates files and commits before execution
+- Protected branch detection (main, master, production)
+- Comprehensive error handling with custom exceptions
+- Session tracking for undo support
+
+### Changed
+
+- Reorganized module structure for better maintainability
+- Improved similarity graph with weighted factors
+- Enhanced diff parser with better language support
+- Updated CLI with new v2 commands
+- Improved README with mermaid diagram and examples
+
+### Documentation
+
+- Comprehensive README v2 with architecture overview
+- CONTRIBUTING.md with development guidelines
+- Improved docstrings across all modules
+- Architecture diagrams and workflow examples
+
+## [0.1.0] - 2025-12-01 - Initial Release
+
+### Added
+
+#### Core Features
+- Git repository scanning and file detection
+- Diff parsing and structured change extraction
+- File summarization and keyword extraction
+- Semantic embeddings using sentence-transformers
+- ML-based clustering (agglomerative, greedy fallback)
+- LLM integration for cluster analysis
+- Conventional commit message generation
+- Rich terminal UI for preview
+- Session tracking and undo support
+
+#### CLI Commands
+- `smart-commit run`: Main commit workflow
+- `smart-commit preview`: Preview without executing
+- `smart-commit undo`: Undo last session
+- `smart-commit config`: Configuration management
+- `smart-commit doctor`: Diagnostic checks
+- `smart-commit init`: Repository initialization
+- `smart-commit version`: Version info
+
+#### Models & Configuration
+- FileDiff dataclass for file changes
+- CommitCluster dataclass for grouped changes
+- CommitType enum for Conventional Commits
+- SessionInfo for undo tracking
+- Config class with Pydantic validation
+
+#### Testing
+- Basic test suite for git operations
+- Tests for diff parsing
+- Tests for clustering
+- Tests for commit message generation
+
+---
+
+## Migration Guide: v1 to v2
+
+If you're upgrading from v0.1.0 to v0.2.0:
+
+### Breaking Changes
+- Module structure reorganized (imports may need updating)
+- New exception types for better error handling
+- Configuration format unchanged (compatible)
+
+### New Features to Explore
+- Plugin system for framework-specific support
+- Enhanced offline mode (`--offline` flag)
+- Safety checker for protected branches
+- Improved LLM cluster analysis
+
+### Update Instructions
+
+```bash
+# Update from PyPI
+pip install --upgrade smart-commit
+
+# Or from source
+git clone https://github.com/hamxa296/Smart-Commit.git
+cd Smart-Commit
+pip install -e .
+```
+
+---
+
+## Planned for Future Releases
+
+- [ ] Interactive commit editing UI
+- [ ] Learning mode (observe user patterns)
+- [ ] VS Code extension
+- [ ] Cursor/Windsurf IDE support
+- [ ] Pull request generation
+- [ ] Changelog generation
+- [ ] Team collaboration features
+- [ ] Analytics and insights
+- [ ] GitHub Actions integration
+

smart_commit_cli-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,319 @@
+# Contributing to Smart Commit
+
+Thank you for your interest in contributing to Smart Commit! This document provides guidelines and instructions for contributing.
+
+## Code of Conduct
+
+We are committed to providing a welcoming and inclusive environment for all contributors. Please be respectful and constructive in all interactions.
+
+## Getting Started
+
+### Fork and Clone
+
+```bash
+# Fork the repository on GitHub
+
+# Clone your fork
+git clone https://github.com/YOUR_USERNAME/Smart-Commit.git
+cd Smart-Commit
+
+# Add upstream remote
+git remote add upstream https://github.com/hamxa296/Smart-Commit.git
+```
+
+### Development Setup
+
+```bash
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install in development mode
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Format code
+black smart_commit tests
+ruff check --fix smart_commit tests
+
+# Type checking
+mypy smart_commit
+```
+
+## Development Workflow
+
+### 1. Create a Feature Branch
+
+```bash
+git checkout -b feature/your-feature-name
+```
+
+### 2. Make Your Changes
+
+- Write clean, well-documented code
+- Follow the existing code style
+- Add tests for new functionality
+- Update documentation as needed
+
+### 3. Test Your Changes
+
+```bash
+# Run all tests
+pytest -v
+
+# Run specific test
+pytest tests/test_git_service.py -v
+
+# Check coverage
+pytest --cov=smart_commit
+```
+
+### 4. Format and Lint
+
+```bash
+# Format with Black
+black smart_commit tests
+
+# Lint with Ruff
+ruff check --fix smart_commit tests
+
+# Type check
+mypy smart_commit
+```
+
+### 5. Commit and Push
+
+```bash
+# Commit with descriptive message
+git commit -m "feat(module): describe your changes"
+
+# Push to your fork
+git push origin feature/your-feature-name
+```
+
+### 6. Create a Pull Request
+
+Create a PR on GitHub with:
+- Clear description of changes
+- Reference to related issues
+- Tests for new functionality
+- Updated documentation
+
+## Areas for Contribution
+
+### High Priority
+
+- [ ] AST parsing improvements for better code understanding
+- [ ] Additional language plugins (Next.js, FastAPI, etc.)
+- [ ] IDE extensions (VS Code, Cursor, Windsurf, JetBrains)
+- [ ] Test coverage improvements
+- [ ] Documentation enhancements
+
+### Medium Priority
+
+- [ ] Learning mode for user preferences
+- [ ] Pull request generation
+- [ ] Changelog generation
+- [ ] Analytics dashboard
+- [ ] Performance optimizations
+
+### Low Priority
+
+- [ ] UI themes
+- [ ] Configuration profiles
+- [ ] GitHub Actions integration
+- [ ] Team collaboration features
+
+## Code Style
+
+### Python Style Guide
+
+- Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/)
+- Use type hints for all functions
+- Use docstrings (Google style) for modules, classes, and functions
+- Maximum line length: 100 characters
+- Use Black for formatting
+
+### Example
+
+```python
+"""Module docstring."""
+
+def process_data(items: List[str], threshold: float = 0.5) -> Dict[str, int]:
+    """Process a list of items.
+    
+    Args:
+        items: List of items to process.
+        threshold: Similarity threshold (default 0.5).
+    
+    Returns:
+        Dictionary mapping item to score.
+    
+    Raises:
+        ValueError: If threshold is not in [0, 1].
+    """
+    if not (0 <= threshold <= 1):
+        raise ValueError("Threshold must be in [0, 1]")
+    
+    result = {}
+    for item in items:
+        result[item] = len(item) * threshold
+    
+    return result
+```
+
+## Commit Message Format
+
+Follow [Conventional Commits](https://www.conventionalcommits.org/):
+
+```
+<type>(<scope>): <subject>
+
+<body>
+
+<footer>
+```
+
+### Types
+
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation
+- `style`: Code style changes
+- `refactor`: Code refactoring
+- `perf`: Performance improvement
+- `test`: Test additions/changes
+- `chore`: Build, dependencies, etc.
+
+### Examples
+
+```
+feat(ai): add LLM cluster review
+
+Implement ClusterReviewer that uses LLM to analyze
+and suggest improvements to file clusters.
+
+Closes #42
+```
+
+```
+fix(clustering): handle empty embeddings gracefully
+
+Prevent crashes when embedding generation fails
+by using fallback clustering strategy.
+
+Fixes #38
+```
+
+## Testing
+
+### Test Structure
+
+```python
+"""Tests for module_name."""
+
+import pytest
+from smart_commit.module_name import ClassName
+
+
+class TestClassName:
+    """Test suite for ClassName."""
+    
+    def test_basic_functionality(self):
+        """Test basic functionality."""
+        obj = ClassName()
+        result = obj.method()
+        assert result is not None
+    
+    def test_error_handling(self):
+        """Test error handling."""
+        obj = ClassName()
+        
+        with pytest.raises(ValueError):
+            obj.method_that_raises()
+```
+
+### Running Tests
+
+```bash
+# All tests
+pytest
+
+# Specific file
+pytest tests/test_file.py
+
+# Specific test
+pytest tests/test_file.py::TestClass::test_method
+
+# With output
+pytest -v -s
+
+# Coverage
+pytest --cov=smart_commit --cov-report=html
+```
+
+## Documentation
+
+### Docstring Format
+
+Use Google-style docstrings:
+
+```python
+def function_name(param1: str, param2: int) -> bool:
+    """Short description.
+    
+    Longer description if needed. Explain what the function does,
+    its purpose, and any important details.
+    
+    Args:
+        param1: Description of param1.
+        param2: Description of param2.
+    
+    Returns:
+        Description of return value.
+    
+    Raises:
+        ValueError: When input is invalid.
+        RuntimeError: When operation fails.
+    
+    Example:
+        >>> result = function_name("test", 42)
+        >>> assert result is True
+    """
+    pass
+```
+
+### README Updates
+
+When adding features, update README.md:
+- Add to features list
+- Add to commands section if CLI command
+- Update architecture if module added
+- Add to roadmap if incomplete
+
+## Release Process
+
+1. Update `__version__` in `smart_commit/__init__.py`
+2. Update CHANGELOG.md
+3. Update README.md if needed
+4. Create git tag: `git tag v0.2.0`
+5. Push: `git push upstream main --tags`
+6. Create GitHub Release with notes
+7. Build and publish to PyPI
+
+## Questions or Issues
+
+- Create a [GitHub Issue](https://github.com/hamxa296/Smart-Commit/issues)
+- Start a [Discussion](https://github.com/hamxa296/Smart-Commit/discussions)
+- Contact: [maintainer email]
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.
+
+---
+
+Thank you for helping make Smart Commit better! 🙏
+