Skip to content

README.md

Latest commit

 

History

History
77 lines (49 loc) · 2.04 KB

README.md

File metadata and controls

77 lines (49 loc) · 2.04 KB

{{PROJECT_NAME}}

CI License

One-line description of what this project does.

Overview

Prerequisites

  • Python 3.11+
  • Docker (for container builds)
  • pre-commit (for local development)

Quick Start

# Clone the repo
git clone https://github.com/llm-d/{{PROJECT_NAME}}.git
cd {{PROJECT_NAME}}

# Install dependencies (with dev extras)
pip install -e ".[dev]"

# Install pre-commit hooks
pre-commit install

# Run tests
make test

# Run linters
make lint

Development

See CONTRIBUTING.md for development guidelines, coding standards, and how to submit changes.

Common Commands

make help           # Show all available targets
make install        # Install project + dev dependencies
make test           # Run tests with pytest
make lint           # Run ruff linter + format check
make fmt            # Auto-format code with ruff
make image-build    # Build multi-arch container image
make pre-commit     # Run pre-commit hooks

Architecture

Configuration

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

All commits must be signed off (DCO). See PR_SIGNOFF.md for instructions.

Security

To report a security vulnerability, please see SECURITY.md.

License

This project is licensed under the Apache License 2.0 - see LICENSE for details.