Contributing

This section is for ESPnet3 contributors and recipe authors.

Important

Please keep contributions small, reviewable, and documented. When behavior changes, tests and docs should usually change in the same PR.

Start here

If you want to work on ESPnet3 code, start with the local setup and PR flow.

Dev setup

Create a Pixi-based development environment for ESPnet3.

CI and PR

Run checks locally and prepare changes for review.

Core overview

Read the main ESPnet3 architecture docs before changing shared behavior.

Extend ESPnet3

Use these pages when you add new building blocks.

Adding a stage

Add a new stage to an existing system.

Quality and policy

These pages explain repository expectations.

Writing docs

Edit Markdown, use Vue components, and understand the current VuePress setup.

Docstring guide

Write public and private docstrings in the expected style.

Naming conventions

Keep names consistent across code, config, docs, and imports.