Skip to content

Contributing

Quiver is developed on GitHub at kheif/quiver. Bug reports, ideas and pull requests are welcome. The full guide is CONTRIBUTING.md.

Quiver needs Go (the version in go.mod or later) and git.

Terminal window
make build # bin/quiver
make test # go test ./..., including the end-to-end suite in e2e/
make lint # golangci-lint
go test -race ./... # as CI runs it on Linux and macOS

QUIVER_HOME points Quiver at another library folder, so you can try changes without touching ~/.quiver:

Terminal window
QUIVER_HOME=/tmp/quiver-try ./bin/quiver init --yes
  • Keep one change per pull request, with tests.
  • Every command has unit tests; a user-facing flow also has an end-to-end test in e2e/.
  • Update the README and the help text when behavior changes.

The work is planned in tasks/: open questions are in tasks/backlog.md, technical decisions in tasks/decisions.md.

The website is in web/, built with Astro and Starlight. Each docs page has an Edit page link at the bottom.

  • Docs pages are Markdown files in web/src/content/docs/docs/. Link to other pages as /docs/<page>/; the base path is added at build time.
  • The CLI reference is generated from quiver --help. Change the help text in internal/cli, not the page.
  • The README stays the short reference. When a change affects users, update the README, the help text and the matching docs page together.
Terminal window
cd web
npm ci
npm run dev # http://localhost:4321/quiver/

See web/README.md for the build, the tests and the deployment.