Contributing

How to contribute to pyRPC.

We welcome contributions of all sizes, from fixing a typo to adding a new adapter.

Getting Started

See CONTRIBUTING.md on GitHub for the full guide covering:

Development setup (Python 3.11+, Node.js 20+)
Repository structure
Branch naming conventions (feat/, fix/, chore/, docs/)
Commit message format (Conventional Commits)
PR template and review expectations

Quick Start

git clone https://github.com/pyrpc/pyrpc
cd pyrpc
uv sync
cd docs && npm install && cd ..

Scope

Keep PRs focused on one subsystem, core, adapter, client, codegen, or docs. Mixed-concern PRs are hard to review and prone to regressions.

Questions

Open a Discussion for questions or feature ideas before opening a PR.

Skills

Install pyRPC agent skills so your coding assistant follows library conventions and patterns.

Sponsors

Support the development of pyRPC.

On this page

Getting Started