CONTRIBUTING.md

Contributing to pywebview

Thanks for your interest in pywebview. The full contributor documentation lives at pywebview.flowrl.com/contributing and in docs/contributing:

• Development set-up and work-flow
• Bug reporting
• Documentation
• Releasing
• Donating

Quick start

git clone https://github.com/<username>/pywebview
cd pywebview
python3 -m venv venv          # Python 3.10 or newer
source venv/bin/activate
pip install -e ".[dev]"
pre-commit install
python examples/simple_browser.py

Before opening a pull request:

pre-commit run --all-files    # ruff lint + format, whitespace, YAML
pytest tests

Add an entry to docs/CHANGELOG.md for any user-visible change, and update docs/api when you change the public API.

Before you start work on a new feature, please open an issue to discuss it first.

AGENTS.md documents the architecture, the backend contract and the coding conventions in more depth. It is written for AI coding agents, but it is the most complete description of how the code fits together.