Skip to content

chore: add bun run check to build instructions - #31

Merged
lambdakilo merged 1 commit into
mainfrom
17/chore/build-instructions
Aug 10, 2026
Merged

chore: add bun run check to build instructions#31
lambdakilo merged 1 commit into
mainfrom
17/chore/build-instructions

Conversation

@lambdakilo

@lambdakilo lambdakilo commented Aug 7, 2026

Copy link
Copy Markdown
Member

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

  • readme and pr template. made more ergonomic formatting to pr template but id like comments on whether or not those changes are good or not

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 build - build succeeds
  • I tested the relevant changes manually

Reviewer manual testing checklist

  • read changes thorhoughly in the changed files and check if they make sense

@lambdakilo
lambdakilo requested review from guildm4ster and a lite review from Copilot and removed request for Copilot August 7, 2026 06:50
Copilot AI lite review requested due to automatic review settings August 7, 2026 07:46
@lambdakilo
lambdakilo force-pushed the 17/chore/build-instructions branch from bfbb1c8 to 8d127d4 Compare August 7, 2026 07:46

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 check and 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.


-

-

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

theres less friction for authors to write the changes when theres no so no bad review you naughty copilot ai bot.

## Reviewer manual testing checklist

- [ ]
- [ ] No newline at end of file

@guildm4ster guildm4ster left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@guildm4ster guildm4ster added docs Improvements or additions to documentation chore labels Aug 10, 2026
@lambdakilo
lambdakilo merged commit 2f304e4 into main Aug 10, 2026
1 check passed
@lambdakilo
lambdakilo deleted the 17/chore/build-instructions branch August 10, 2026 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README.md on how to run the code

3 participants