Skip to content

CLAUDE.MD

Latest commit

 

History

History
170 lines (106 loc) · 2.57 KB

CLAUDE.MD

File metadata and controls

170 lines (106 loc) · 2.57 KB
Raw

CLAUDE.MD

This file contains information to help Claude Code understand and work with this project effectively.

Project Overview

Repository: sv-vs Type: [Add project type - web app, library, tool, etc.] Tech Stack: [Add technologies used]

Purpose

[Describe what this project does and its main goals]

Project Structure

sv-vs/
├── [Add main directories and their purpose]
└── CLAUDE.MD

Development Setup

Prerequisites

  • [List required software/tools]
  • [Add version requirements]

Installation

# Clone the repository
git clone [repository-url]
cd sv-vs

# Install dependencies
[Add installation commands]

Running the Project

# Development mode
[Add dev commands]

# Production build
[Add build commands]

# Tests
[Add test commands]

Architecture & Key Concepts

Core Components

[Describe the main components/modules of the system]

Data Flow

[Explain how data moves through the system]

Key Design Decisions

[Document important architectural decisions]

Working with Claude Code

Common Tasks

  1. Adding New Features

    • [Describe the typical workflow]
    • [List files that usually need changes]

  2. Bug Fixes

    • [Explain debugging approach]
    • [Common issues and solutions]

  3. Testing

    • [Testing strategy]
    • [How to run and write tests]

Code Style & Conventions

  • [Coding standards]
  • [Naming conventions]
  • [Comment guidelines]
  • [Commit message format]

Important Files

  • CLAUDE.MD - This file, project guide for Claude
  • [List other critical files and their purposes]

Git Workflow

Branch Strategy

  • main - Production-ready code
  • claude/* - Feature branches for Claude Code development
  • [Add other branch conventions]

Commit Guidelines

<type>: <subject>

<body>

<footer>

Types: feat, fix, docs, style, refactor, test, chore

Testing

Test Structure

[Describe test organization]

Running Tests

[Test commands]

Coverage Requirements

[Coverage expectations]

Deployment

[Deployment process and requirements]

Troubleshooting

Common Issues

  1. [Issue]
    • Symptoms: [Description]
    • Solution: [Fix]

Resources

  • [Documentation links]
  • [Related repositories]
  • [External resources]

Notes for Claude

Context to Remember

  • [Important project-specific context]
  • [Gotchas and edge cases]
  • [Performance considerations]

Avoid

  • [Things not to do]
  • [Deprecated patterns]

Prefer

  • [Recommended approaches]
  • [Best practices for this codebase]

Last updated: 2026-01-07