Clarify Bun README preload and build-plugin requirements
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 90/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- bun
- Domain
- documentation
Research direction
Start in packages/bun/README.md by reviewing the existing preload documentation and the references to sentryBunPlugin from @sentry/bun/plugin. Done means the README has a separate instrument.js preload example, explains initialization order and build-time instrumentation requirements, and links to the full build example without duplicating it.
Written by the indexing model from the issue text.
Description
Update packages/bun/README.md with a separate instrumentation file and a bun --preload ./instrument.js app.js startup example.
Briefly explain that preload ensures initialization order, while sentryBunPlugin from @sentry/bun/plugin enables build-time instrumentation of supported bundled dependencies. Dependencies needing this instrumentation must be included in the bundle. Link to the full build example rather than duplicating it.
Preload already existed before v11; the build-plugin explanation is the key v11 addition.
Docs PR: getsentry/sentry-docs#19361
- Dominant language
- TypeScript
- Stars
- 8.7k
- Forks
- 1.9k
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 562
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from getsentry/sentry-javascript
-
Browser Waiting for: Product Owner
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
getsentry/sentry-javascript#24577 · 1 comment ·
-
Task
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
getsentry/sentry-javascript#24558 · 1 comment ·
-
Task
Difficulty 1/5 Under an hour Newbie friendliness 90/100
getsentry/sentry-javascript#24557 · 1 comment ·
-
Task
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
getsentry/sentry-javascript#24556 · 1 comment ·
-
Task
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
getsentry/sentry-javascript#24547 · 1 comment ·
All issues in getsentry/sentry-javascript
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
safetrustcr/dApp-SafeTrust#426 ·
-
area:workflow bug ready-for-agent
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
fil-donadoni/tolaria#4409 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Fission-AI/OpenSpec#1960 ·
-
Add dependabot Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
corsairdev/corsair#1764 ·