Contribution Guides - UpstandPlatform/OpenRive GitHub Wiki
In-depth guides for people working on OpenRive. New here? Read Contributing first, along with the Code of Conduct. To report a vulnerability, follow the Security Policy.
| Guide | What's inside |
|---|---|
| Development | Setup, project layout, how a feature flows from API to UI, adding actions, panels and storage drivers |
| Code style | TypeScript, React and naming conventions, comments, commits |
| Testing | Round-trip tests, the Rive corpus, MCP tests, manual checks in the browser |
| Templates | Building a starter template with the OpenRive API |
| Docs | Writing and structuring documentation |
| AI collaboration | Working with AI coding agents: the included agents and skills, MCP, and review rules |
| Pull requests & reviews | What reviewers look for, and how releases happen |
- Editing UI for preserved features: bones and skinning, meshes, constraints, nested artboards, blend states, layouts, events
- Data binding: view model editing in the editor (preview already supports it)
- Font subsetting to shrink files with text
- Templates that teach one Rive feature each
- Translations of the docs
-
File compatibility:
.rivfiles that don't round-trip or render differently (open an issue with the file)
This page is generated from contribution/README.md. Suggest an edit.