Contributing
Quiver is developed on GitHub at kheif/quiver. Bug reports, ideas and pull requests are welcome. The full guide is CONTRIBUTING.md.
Build and test
Section titled “Build and test”Quiver needs Go (the version in go.mod or later) and git.
make build # bin/quivermake test # go test ./..., including the end-to-end suite in e2e/make lint # golangci-lintgo test -race ./... # as CI runs it on Linux and macOSQUIVER_HOME points Quiver at another library folder, so you can try changes without touching ~/.quiver:
QUIVER_HOME=/tmp/quiver-try ./bin/quiver init --yesPull requests
Section titled “Pull requests”- 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.
Issues
Section titled “Issues”- Report a bug or ask for a feature. Include
quiver --versionand the output ofquiver doctor. - Security problems go through the private vulnerability report, not an issue.
Edit this website
Section titled “Edit this website”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 ininternal/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.
cd webnpm cinpm run dev # http://localhost:4321/quiver/See web/README.md for the build, the tests and the deployment.