Contributing
Build and extend the Yavio platform
Thanks for your interest in contributing to Yavio! The entire platform is open source (MIT) and we welcome contributions of all kinds — bug fixes, features, documentation, and more.
Code of Conduct
By participating, you agree to uphold our Code of Conduct. Be respectful, constructive, and collaborative.
Where to Start
Development Setup
Clone, install, and run Yavio locally
Architecture
Understand the platform's components and data flow
Project Structure
Navigate the monorepo layout
Testing
Run and write tests
Code Style
Formatting, linting, and TypeScript conventions
Specs Guide
Read and update the /specs directory
How to Contribute
- Check existing issues — look for an open issue or create one before starting work
- Fork the repo and create a branch from
main - Follow the branch naming convention —
feat/,fix/,docs/,refactor/,test/,chore/ - Write tests for any new functionality
- Run the checks before pushing (
pnpm turbo run build typecheck lint && pnpm test) - Open a pull request using the PR template