Skip to content

Contributing

Thanks for your interest! This project is open-source (MIT).

Workflow

  • We work on the dev branch; main is reserved for releases.
  • Commits follow Conventional Commits.
  • Development is TDD : write a failing test, then make it pass.

Local development

# Driver tests
./gradlew -p epaper-driver test

# App (Quasar)
cd app
npm install
npm test        # Vitest
npm run dev     # dev server

Submitting changes

  1. Fork the repository.
  2. Create a feature branch.
  3. Commit with a Conventional Commits message.
  4. Open a pull request against dev.