Skip to content

Bug Triaging

Jump to bottom
Gar edited this page Mar 16, 2022 · 23 revisions

Initial Triage Steps

  1. ☑️ Ensure the ticket is a bug, & not a feature request/enhancement
  1. ☑️ Ensure the ticket is using our issue template
  • If so, continue...
  • If not, use discretion/respond for clarity (see templates below) & 🚫 close ticket
  1. ☑️ Ensure bug is unique (ie. search for existing/similar tickets)
  • If so, continue...
  • If not, add the label Duplicate, link the existing issue (see templates below) & 🚫 close ticket
  1. ☑️ Ensure bug is reproducible on the latest version of the npm CLI
  • If so, continue...
  • If not, ask them to upgrade (see templates below) & 🚫 close ticket
  1. (Optional) ☑️ Write a failing test that reproduces bug & submit a PR
  2. ☑️ Respond w/ a clarifying question(s) (see templates below)
  3. ☑️ Determine & label Priority accordingly (no label is required for low-priority icebox/backlogged bugs)
  4. Move to next issue...

Response Templates

Duplicate

**Closing:** this looks to be similar if not a duplicate of an existing issue, <issue_id>. If you believe your instance is unique, please provide further clarifying details.

Try latest?

<authors_username> can you try replicating this problem on the latest version of `npm`? (ie. `npm i -g npm`)

Not Using the Issue Template

**Closing:** please use our [issue template](https://github.com/npm/cli/issues/new/choose) &/or review our [contributing guidelines](https://github.com/npm/cli/blob/latest/CONTRIBUTING.md#reporting-bugs).

Triaging third-party libraries bugs

**Closing:** we do not support/triage third-party libraries or tooling bugs; Please file an issue with the relevant project.

Create an RFC

Not a bug:

<authors_username> Thanks for filing this! Since this is working as intended, can you please open an [RFC issue](https://github.com/npm/rfcs) with some details on how you could/would like to see this changed?

New idea:

<author_username> Thanks for taking the time to share your idea! While new ideas are always appreciated I would please ask you to open an [issue or discussion in our RFC repo](https://github.com/npm/rfcs) instead since that's the right place in order to get more attention from the rest of the team and the community.

npm ERR! cb() never called!

Note: use your discretion, low/no information about the environment/circumstances for when this occurred should be closed with the following:

**Closing:** this error can arise for a number of reasons; Please read [this document](https://github.com/npm/cli/wiki/%22cb()-never-called%3F-Exit-handler-never-called%3F-I'm-having-the-same-problem!%22) & refile an issue with as much information as possible if you're able to **consistently reproduce** this error.

If it is an npm install error for a package with a large dependency graph, it's possible it was running on a resource constrained system which produced the error, and the issue can be closed with the following:

**Closing:** We suspect this has to do with a combination of resource constraints within the device/program being used and the large amount of transient dependencies being installed by this command.

We've opened https://github.com/npm/statusboard/issues/395 for us to look deeper into this and track the discussion and fixes around it. You can also read [this document](https://github.com/npm/cli/wiki/%22cb()-never-called%3F-Exit-handler-never-called%3F-I'm-having-the-same-problem!%22) for more information on why this issue might be happening currently and ways to debug it.

Registry

**Closing:** this looks to be an issue with the registry which is outside the scope of this repo. For registry support please go to [npmjs.com/support](https://www.npmjs.com/support). If you believe this is a bug with the cli, please provide further clarifying details.

Typescript

**Closing:** Typically we don't accept typescript definitions into the repos themselves, as we are not willing to maintain them.  If you want, you can request to become a [Definition owner](https://github.com/DefinitelyTyped/DefinitelyTyped#definition-owners) for the `@types` scoped module for this package.

Old Issue

If during triage we have commented in an old issue and haven't heard back in at least a week. Note this leaves the door open for them to reopen if it's still an issue

**Closing** due to age.  If this is still a problem please feel free to reopen this issue, or create a new issue w/ steps to reproduce.

npm docs | npm | github.community

Clone this wiki locally