Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (50 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

74 lines (50 loc) · 1.64 KB
Raw

Contributing to SteadyText

We welcome contributions to SteadyText! This document provides guidelines for contributing to the project.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/steadytext.git
  3. Create a new branch: git checkout -b feature/your-feature-name

Development Setup

We use UV, a modern, blazing-fast Python package manager that's 10-100x faster than pip.

# Install UV
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone and setup
git clone https://github.com/your-username/steadytext.git
cd steadytext

# Install in development mode with all dependencies
uv sync --all-extras --dev

Making Changes

  1. Write your code following the existing style
  2. Add tests for new functionality
  3. Ensure all tests pass
  4. Update documentation as needed
  5. Follow the project's commit message conventions

Submitting Changes

  1. Push your changes to your fork
  2. Create a pull request with a clear description
  3. Wait for review and address any feedback

Code Style & Testing

We use ruff for linting and formatting, and pytest for testing.

Running Tests

# Run all tests
uv run python -m pytest

# Run with coverage
uv run python -m pytest --cov=steadytext

# Run specific test file
uv run python -m pytest tests/test_steadytext.py

# Allow model downloads in tests
STEADYTEXT_ALLOW_MODEL_DOWNLOADS=true uv run python -m pytest

Linting and Formatting

# Check for linting errors
uvx ruff check .

# Format code
uvx ruff format .
uvx black .

Questions?

Feel free to open an issue if you have questions or need help!