Contributing

Quick Start

# Clone the repository
git clone https://github.com/3D-Tech-Solutions/code-scalpel.git
cd code-scalpel

# Create virtual environment
python -m venv venv
source venv/bin/activate  # Linux/macOS
# or: venv\Scripts\activate  # Windows

# Install in development mode
pip install -e ".[dev]"

# Run tests to verify setup
pytest tests/

Development Setup

Prerequisites

• Python 3.10 or later
• Git
• VS Code (recommended)

Dependencies

We use a standard set of Python development tools:

• pytest - Testing
• black - Formatting
• ruff - Linting
• pyright - Type checking

Verify Installation

# Run full test suite
pytest tests/

# Check code style
black --check src/ tests/
ruff check src/ tests/

# Type checking
pyright src/

Code Style

We strictly enforce style rules in CI.

Formatting (Black)

# Format all code
black src/ tests/

• Line length: 88 characters
• Python 3.10+ syntax

Linting (Ruff)

# Lint and auto-fix
ruff check --fix src/ tests/