Skip to content

Contributing to Code Scalpel

Thank you for your interest in contributing to Code Scalpel! This guide will help you get started.

  • Development Setup

    Set up your local development environment.

    Setup Guide

  • Code Style

    Coding standards and formatting guidelines.

    Style Guide

  • Testing

    Writing and running tests.

    Testing Guide

  • Documentation

    Contributing to documentation.

    Docs Guide

Ways to Contribute

🐛 Bug Reports

Found a bug? Please open an issue with:

  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Environment details (Python version, OS, etc.)

💡 Feature Requests

Have an idea? Open a feature request with:

  • Use case description
  • Proposed solution
  • Alternative approaches considered

🔧 Pull Requests

Ready to contribute code?

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Write tests
  5. Submit a PR

Development Workflow

graph LR
    A[Fork] --> B[Branch]
    B --> C[Code]
    C --> D[Test]
    D --> E[Lint]
    E --> F[PR]
    F --> G[Review]
    G --> H[Merge]

Quick Start

# Clone your fork
git clone https://github.com/YOUR_USERNAME/code-scalpel.git
cd code-scalpel

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

# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest tests/

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

Code of Conduct

Please read and follow our Code of Conduct.

Getting Help