Skip to content

docs: add prerequisites and setup instructions to Contributing section #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
myakura wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: add prerequisites and setup instructions to Contributing section #13

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c403183
docs: add prerequisites and setup instructions to Contributing section
myakura Mar 16, 2026
5621589
Merge remote-tracking branch 'upstream/main' into improve-contributin…
myakura Mar 17, 2026
38fbec7
docs: refer to .tool-versions for exact prerequisite versions
myakura Mar 17, 2026
8dbc939
Potential fix for pull request finding
myakura Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,30 @@ This is error text.

## Contributing

### Prerequisites

- [Node.js](https://nodejs.org/)
- [Bun](https://bun.sh/)

See the Node.js and Bun entries in `.tool-versions` for the exact versions used in this project.

### Setup

```sh
bun install
```

### Commands

```sh
bun test # run tests

@myakura myakura Mar 17, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

i'm planning to drop vitest dependency for bun:test in #12 so let's just wait a bit see if it's accepted.

bun run build # build the package
bun run tsc # type check
bun run ci # lint and format check
```

### Workflow

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
Expand Down
Loading