From 8d127d4917d0fa810e774653e45ae699e0b6abe1 Mon Sep 17 00:00:00 2001 From: Akira Taguchi <31825085+lambdakilo@users.noreply.github.com> Date: Fri, 7 Aug 2026 09:45:21 +0300 Subject: [PATCH] chore: add bun run check to build instructions --- .github/pull_request_template.md | 15 +++++-------- README.md | 37 +++++++++++++++++++++++++++++++- 2 files changed, 41 insertions(+), 11 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5193c76..0800595 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,22 +1,17 @@ ## Summary - ## Related issue - Closes # ## Changes made - -- - +- ## Author checklist - - [ ] Matches the spec -- [ ] `bun run test` - all tests pass - [ ] `bun run format` - code has been formatted -- [ ] `bun run lint` - no eslint errors +- [ ] `bun run lint` - no prettier/eslint errors +- [ ] `bun run check` - no svelte-check/TypeScript errors +- [ ] `bun run test` - all tests pass - [ ] `bun run build` - build succeeds - [ ] I tested the relevant changes manually ## Reviewer manual testing checklist - -- [ ] +- [ ] \ No newline at end of file diff --git a/README.md b/README.md index eeb7434..85c9254 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,41 @@ Bounties are organized in the open on Nostr, work is paid in Bitcoin - a permissionless design suitable for AI agents. Funds are locked in a trust-minimized multiparty escrow built on Arkade until the work is done. Clear acceptance criteria enable predictable, machine-verifiable outcomes by design. Disputes are resolved automatically based on oracle attestations, with a panel of human jurors acting as a fallback mechanism. -# License +## Build + +Install [Bun](https://bun.sh), then install dependencies: + +```sh +bun install +``` + +### Run + +Start the development server: + +```sh +bun run dev +``` + +Build for production and preview the result: + +```sh +bun run build +bun run preview +``` + +### Checks + +Run these before submitting a PR, in this order: + +```sh +bun run format # format code with prettier +bun run lint # prettier/eslint checks +bun run check # svelte-check / TypeScript +bun run test # unit tests +bun run build # production build +``` + +## License This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.