Skip to content

docs: document minimum bun version requirement #642

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
r69shabh wants to merge 2 commits into
base: staging
Choose a base branch
from
Open

docs: document minimum bun version requirement #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
babe651
docs: document minimum bun version requirement
r69shabh Aug 20, 2026
6fdaca9
docs(contributing): note packageManager bun pin alongside minimum ver…
r69shabh Aug 22, 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
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,15 @@ git clone https://github.com/databuddy-analytics/Databuddy.git
cd databuddy
```

2. Install dependencies:
2. Install dependencies (requires Bun ≥ 1.2.0 — run `bun --version` to check, upgrade at https://bun.sh if needed):

```bash
bun install
```

> [!NOTE]
> Bun ≥ 1.2.0 is only the minimum required for `catalog:` protocol support. The repo pins an exact version via the `packageManager` field in `package.json`, so contributors should use that version to avoid install conflicts (check it with `grep packageManager package.json`, or activate it via Corepack with `corepack prepare bun@<version> --activate`).

3. Set up environment variables:

```bash
Expand Down
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
"ultracite": "^7.6.1"
},
"engines": {
"node": ">=20"
"node": ">=20",
"bun": ">=1.2.0"
Comment thread
r69shabh marked this conversation as resolved.
},
"overrides": {
"protobufjs": ">=7.5.5",
Expand Down