Align Node README initialization with v11

Open
#24,554 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
javascript, node.js
Domain
documentation

Research direction

Open packages/node/README.md and review the initialization examples for CommonJS and ESM applications. Confirm both examples use node --import, filenames are consistent, the existing bundling guidance remains, and the installation guide is still linked for alternative setups.

Written by the indexing model from the issue text.

Description

Task

Update packages/node/README.md to show preloading the instrumentation file with node --import for both CommonJS and ESM applications. Correct the implication that a top-level import alone provides equivalent automatic instrumentation, and make filenames consistent.

Keep the existing bundling guidance and link to the installation guide for alternative setups.

Docs PR: getsentry/sentry-docs#19368

Dominant language
TypeScript
Stars
8.7k
Forks
1.9k
Avg merge
1d 18h
Merged PRs (30d)
543

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getsentry/sentry-javascript

All issues in getsentry/sentry-javascript

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.