Pull Requests - UpstandPlatform/OpenRive GitHub Wiki

Before opening

  • Linked issue (or a clear description of the problem)
  • bun run check-types, bun run lint, bun run test pass
  • Extra tests for your area (see testing)
  • Docs updated
  • Screenshots or a recording for UI changes

What reviewers look for

  1. File safety: no regressions in round-tripping, and new object types have tests.
  2. One API: content features live in src/lib/rive and are reachable from UI, CLI and MCP where it makes sense.
  3. UX consistency: shortcuts in the action registry, context menus, undo, read-only mode respected, no clipped popovers.
  4. Local-first: no required network calls, telemetry or accounts.
  5. Readable code matching the surrounding style.
  6. Scope: one change per PR. Refactors go in separate PRs.

Reviews aim to be quick and kind. Small PRs get merged faster.

AI-assisted PRs

Welcome, with the same bar as any PR. You're responsible for every line. See AI Collaboration.

Releases

Releases come from the Desktop workflow (Actions › Desktop › Run workflow): it bumps the newest vX.Y.Z tag by patch, minor or major, builds the desktop app on all three platforms, creates the tag and publishes a GitHub release with the installers and generated notes. Pushing a vX.Y.Z tag by hand releases that exact version.

Anything that changes stored data (the document shape, the database schema) must stay backward compatible or ship a migration — schema changes need bun run db:generate and both generated files committed.


This page is generated from contribution/pull-requests.md. Suggest an edit.

⚠️ **GitHub.com Fallback** ⚠️