Piqae Docs
Project

Contributing

Create a virtual first print from a fresh checkout without touching physical hardware.

Set up

shell
git clone https://github.com/C4CoffeeCo/piqae.git
cd piqae
cargo xtask doctor
cargo xtask dev

Work safely

  • Read AGENTS.md and the nearest scoped instructions before editing.
  • Use the virtual node and fake printers unless a named physical test is explicitly authorised.
  • Update OpenAPI before public route or schema code.
  • Use append-only PostgreSQL migrations with cross-tenant tests.
  • Run cargo xtask test changed before a focused DCO-signed commit.

Submit

Open an issue or RFC for protocol, profile, compatibility, or deployment changes. Keep pull requests small, include failure-path evidence, preserve the distinction between spooler acceptance and physical delivery, and never use customer documents as fixtures.

Was this page useful?