chore: add bun run check to build instructions - #31
Open
lambdakilo wants to merge 1 commit into
Open
Conversation
lambdakilo
requested review from
guildm4ster
and
a lite review from Copilot
and removed request for
Copilot
August 7, 2026 06:50
lambdakilo
force-pushed
the
17/chore/build-instructions
branch
from
August 7, 2026 07:46
bfbb1c8 to
8d127d4
Compare
There was a problem hiding this comment.
Pull request overview
Updates contributor-facing documentation to include bun run check in the recommended pre-PR checks and to reorder checks so formatting runs before more stringent linting/check steps.
Changes:
- Added a README “Build / Run / Checks” section with Bun install/run commands and a suggested pre-PR check order (including
bun run check). - Updated the PR template checklist to include
bun run checkand reordered checklist items to match the recommended workflow.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Documents Bun-based install/run steps and a pre-PR check sequence including bun run check. |
| .github/pull_request_template.md | Adjusts the author checklist to include bun run check and reorders items for a smoother workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| - | ||
|
|
||
| - |
| ## Reviewer manual testing checklist | ||
|
|
||
| - [ ] | ||
| - [ ] No newline at end of file |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
updated readme and pr template to contain typescript check and reorder format to come before linting, so that easier formats are done before more rigorous linting is done.
Related issue
Closes #17
Changes made
Author checklist
bun run test- all tests passbun run format- code has been formattedbun run lint- no eslint errorsbun run build- build succeedsReviewer manual testing checklist