54 lines (40 loc) · 1.24 KB

Contributing to wzgram

Thanks for your interest in contributing!

Development Setup

This project uses uv for package management and poethepoet for task running.

git clone https://github.com/rjriajul/wzgram
cd wzgram
uv sync --frozen --extra dev
uv run poe api

Running Tests

uv run poe test

Building Docs

uv run poe docs

Available Tasks

Command	Description
`uv run poe venv`	Sync frozen environment
`uv run poe venv-dev`	Sync dev environment
`uv run poe api`	Generate TL API types
`uv run poe test`	Run tests
`uv run poe docs`	Build documentation
`uv run poe build`	Build sdist and wheel
`uv run poe publish`	Publish to PyPI
`uv run poe tag`	Create and push git tag
`uv run poe clean`	Clean all generated files

Submitting Changes

Fork the repo
Create a branch from dev
Make your changes
Run uv run poe test to verify
Submit a pull request to dev

Code Style

Follow the existing Sphinx/reST docstring style for any new methods or types
Add type hints to all function signatures
Keep methods focused and well-documented