Skip to main content

Contributing

Guidelines for contributing to Lumio.

Getting Started​

  1. Clone the repository (access required — Lumio is a closed-source project)
  2. Set up the dev stack: just stack-all
  3. Run the API: just dev-api
  4. Run the web app: just dev-web

Code Style​

  • Rust — Follow rustfmt.toml conventions, pass clippy with -D warnings
  • TypeScript — ESLint + double quotes, Prettier formatting
  • Commits — Conventional commits format

Pull Requests​

  • Create a feature branch from main
  • Include tests for new functionality
  • Update documentation as needed
  • Ensure CI passes before requesting review

Architecture​

See the Developer Guide section for detailed system design documentation.