Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (41 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

56 lines (41 loc) · 1.55 KB

Contributing to memeplotlib

Thanks for your interest in contributing to memeplotlib!

Development Setup

  1. Clone the repository:

    git clone https://github.com/brianckeegan/memeplotlib.git
cd memeplotlib

  2. Install in editable mode with dev dependencies:

    pip install -e ".[dev]"

  3. Run the tests:

    pytest

Code Style

  • Type hints: Use type annotations on all public functions (PEP 604 union syntax X | Y).
  • Docstrings: NumPy-style docstrings on all public classes and functions.
  • Imports: Always include from __future__ import annotations at the top of each module.
  • Linting: We use ruff with a line length of 99. Run ruff check . before submitting.
  • Naming: Private modules use a leading underscore (e.g., _api.py). Public API is re-exported from __init__.py.

Running Tests

# Run all tests
pytest

# Run with coverage
pytest --cov=memeplotlib

# Skip slow (network) tests
pytest -m "not slow"

Pull Request Process

  1. Create a feature branch from main.
  2. Make your changes with clear, descriptive commits.
  3. Add or update tests for any new or changed functionality.
  4. Ensure pytest and ruff check . pass.
  5. Open a PR with a description of what changed and why.

Adding New Templates

memeplotlib discovers templates dynamically from the memegen API. To add custom default text positions for a specific template, modify the _from_api_data method in src/memeplotlib/_template.py.