istanbul-js
Menu
Independent reference

Contributing upstream: prepare a useful Istanbul bug report

Send a reproducible issue to the project that owns the failing stage.

A file tree distinguishes source, tests and build scripts.
Reduce a bug report to the relevant source, a failing test and the configuration needed to reproduce it.

Is the failure in collection, mapping or reporting? Can someone reproduce it without your private repository? Official Istanbul guidance asks for expected behavior, observed behavior, code and environment details. This independent reference cannot accept fixes for the maintainers.

Choose the appropriate project

ProblemStarting point
nyc options or processesnyc repository
Babel instrumentationBabel plugin
Jest settingsJest documentation
Tap coveragetap documentation
This site’s explanationEditorial corrections

Follow the project's current issue template. The official contribution page suggests nyc when the affected Istanbul component is uncertain. Describe observations rather than asserting a root cause you have not isolated.

Prepare a minimal reproduction

Use one source module, one test and the smallest configuration preserving the failure. Include the exact command and exit behavior. Keep a lockfile when dependency resolution matters, and record actual runtime and package-manager versions.

Illustrative issue outline; replace with observed facts

Expected: the unused source module appears with no hits.
Observed: only imported modules appear.
Command: npm run coverage
Environment: actual OS, Node and package-manager versions.
Attachments: minimal source, tests, config and lockfile.

Remove credentials, private code and personal paths before sharing. For transform failures, include configuration and maps from a safe example. For subprocess failures, preserve the process relationship in the reproduction.

Propose a focused change

Search existing issues and follow the repository's discussion guidance. Explain the changed behavior and include a regression check. Use the project's own development checks; examples on this site do not define its workflow.

A documentation correction can be useful without a software patch. Identify the confusing instruction, the environment where it fails and a primary source for the replacement.

Keep this reference separate

Istanbul JS Notes publishes original explanations here. Releases, membership and upstream decisions belong to maintainers. For a correction to these notes, use the editorial contact page with the affected URL and evidence.

Primary sources

Check official documentation against the tools installed in your project. These explanations and examples are independent.