Docs

Contributing

How to contribute to the template itself.

Thanks for considering a contribution.

Scope#

This is a template, not a framework. The goal is to stay small, hackable, and free of magic.

Good contributions:

  • Fix bugs in the template.
  • Improve build / DX.
  • Improve docs and examples.

Out of scope:

  • Heavy theme variants — fork instead.
  • Locking us into a specific deploy target.
  • Niche markdown plugins — add them in your own fork.

Dev loop#

bun install
bun dev
bun run build    # must pass before opening a PR

CI runs bun run build on every PR.

PRs#

  • One concern per PR.
  • Update the README if you change behavior.
  • Match the existing code style (Prettier defaults).