Skip to main content

Contributing

This page is only needed if you plan to contribute directly to Routa itself. If you are trying to use, configure, or self-host Routa, start with Quick Start, Configuration, or Administration instead.

Before You Start​

  • Read Architecture for runtime boundaries.
  • Read Code Style for implementation rules.
  • Read Git Workflow before you begin committing.
  • Keep changes focused and prefer one concern per commit.

Local Setup​

Web​

npm install --legacy-peer-deps
npm run dev

Desktop​

npm install --legacy-peer-deps
npm --prefix apps/desktop install
npm run tauri:dev

Development Expectations​

  • Follow the lint, test, and review rules described in Testing.
  • Do not mix unrelated refactors with feature or bug-fix changes.
  • Update docs when public behavior, commands, or workflows change.

Pull Requests​

  • Explain the user-visible change and the reasoning.
  • Include screenshots or recordings for UI changes.
  • List the checks you ran.
  • Link related issues when applicable.

Bugs And Security​