Project

Contributing

How to set up ProxyWhirl locally, run quality gates, and open pull requests.

Canonical contributor guide: CONTRIBUTING.md on GitHub.

Quick start

git clone https://github.com/wyattowalsh/proxywhirl.git
cd proxywhirl
uv sync
pre-commit install
just quality-gates

Workflow

Branch from main using feature/*, fix/*, or docs/*.
Write tests for behavior changes.
Run just quality-gates before opening a PR.
Update Fumadocs pages in web/content/docs/ when public docs change, then run pnpm --dir web run docs:generate.
Use conventional commits (feat, fix, docs, test, chore, refactor, perf).

Resources

Operations gate matrix — full pre-merge validation commands
Configuration reference — TOML and environment variables

Project

Contributor, design, release, testing, FAQ, and architecture decision records for ProxyWhirl.

Changelog

Release history and notable ProxyWhirl changes.

On this page

Quick start Workflow Resources