Printr

Contributing

Local setup, conventions, and the PR flow.

The canonical contributor guide lives in the repo at CONTRIBUTING.md. Highlights:

Setup

bun install
bun run check   # typecheck + lint + test (the CI gate)

Conventions

  • Errors: neverthrow Result/ResultAsync for failable business logic.
  • Validation: Zod for all I/O; shared schemas in @printr/sdk.
  • TSDoc: required on public SDK exports and register*Tool functions.
  • Commits: Conventional Commits; no Co-Authored-By trailers.

This page summarizes the canonical CONTRIBUTING.md — defer to the repo for the authoritative version.

Architecture

How the SDK, signing, and MCP server fit together.

On this page

SetupConventions