Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (46 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

71 lines (46 loc) · 1.07 KB

Contributing to LTX Desktop

Thanks for taking the time to contribute!

Getting started (development)

Prereqs:

  • Node.js
  • uv (Python package manager)
  • Python 3.12+
  • Git

Setup:

pnpm setup:dev

Run:

pnpm dev

Debug:

pnpm dev:debug

Typecheck:

pnpm typecheck

What we accept right now

  • Bug fixes and small improvements
  • Documentation updates
  • Small, targeted UI fixes

Frontend policy: the frontend is under active refactor. Please avoid large UI/state rewrites for now — open an issue first so we can align on the target direction.

Proposing larger work

Before starting a larger change (especially frontend architecture/state), please open an issue with:

  • The problem you’re trying to solve
  • The proposed approach (1–2 paragraphs is fine)
  • Scope (areas/files likely to change)
  • Any UX or compatibility impact

Wait for maintainer alignment before investing in a major refactor.

Checks

At minimum, run:

  • Type checking:
pnpm typecheck
  • Backend tests:
pnpm backend:test