Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (22 loc) · 772 Bytes

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 772 Bytes
Raw

Contributing

Contributions are welcome. Please open an issue before making a large behavioral change.

Setup

git clone https://github.com/ApeWorX/ape-sourcify.git
cd ape-sourcify
uv sync --all-groups
uv run --locked pre-commit install

Validation

Before opening a pull request, run:

uv run --locked pytest
uv run --locked ruff check .
uv run --locked ruff format --check .
uv run --locked mypy ape_sourcify
uv build
uv run --locked --group release twine check dist/*

Tests must not depend on production Sourcify unless marked live. Use small response fixtures for API behavior and include regression coverage for any bug fix.

Commit messages and pull request titles use Conventional Commits.