Skip to content

developer-guide.md

Latest commit

 

History

History
73 lines (55 loc) · 1.04 KB

developer-guide.md

File metadata and controls

73 lines (55 loc) · 1.04 KB

CodeKarmic Developer Guide

Architecture

flowchart TD
    A[UI Layer] --> B[ReviewManager]
    B --> C[AIService]
    B --> D[GitService]
    C --> E[DeepSeek API]
    D --> F[Local Git Repo]
Loading

Core Components

classDiagram
    class AIService {
        +reviewCode()
        -analyzeCode()
    }
    class GitService {
        +getCommitHistory()
        +getFileDiff()
    }
    AIService --> GitService
Loading

Tech Stack

  • Core Framework: VS Code Extension API
  • AI Integration: DeepSeek Chat Completion
  • Version Control: simple-git
  • Testing Framework: Jest

Development Setup

# Install dependencies
npm install

# Enable watch mode
npm run watch

Building and Testing

# Run unit tests
npm test

# Build extension
npm run build

# Package VSIX
npm run package

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Write/update tests
  5. Submit a pull request

API Configuration

Add your API keys to .env:

DEEPSEEK_API_KEY=your_api_key_here