Skip to content

Bug Triaging

Jump to bottom
Luke Karrys edited this page Apr 10, 2022 · 23 revisions

Key

  • 🩻: triage
  • 🚫: close
  • 🏷: label
  • ❓: ask for info
  • 📝: respond with template
  • 🚛: transfer
  • ➡️: continue

Issue Searches

🩻 Triage-able Issues 🩻

❓ Awaiting Information ❓

🧹 Cleanup 🧹

  • Unlabeled Issues
    • there should be almost none of these but some have fallen through the cracks as we've updated our labelling system. We should make sure these are 🏷 appropriately or closed.

Popular Issues

🩻 Triage Checklist 🩻

  1. ☑️ Ensure the ticket is a bug, & not a feature question/request/enhancement
  • ➡️ If so, continue..
  • If not, do one of the following
    • 🚫 Link to github.community for general questions & close
    • 🚫 Link to npm/feedback for general feedback & close
    • 🚛 Transfer to npm/rfcs for larger structured RFCs
    • 🏷 + Enhancement, 🏷 - Bug, Needs Triage for small/medium cli enhancements
  1. ☑️ Ensure the ticket is using our issue template
  • ➡️ If so, continue...
  • If not, do one of the following:
    • ❓🏷 + Awaiting Information, 🏷 - Needs Triage and ask for clarifying information
    • 🚫 Respond with 📝 no issue template & close
  1. ☑️ Ensure bug is unique (ie. search for existing/similar tickets)
  • ➡️ If so, continue...
  • 🚫 If not, 🏷 + Duplicate, 🏷 - Needs Triage, respond and link with 📝 duplicate & close
  1. ☑️ Ensure bug is not already fixed on latest version of the npm CLI
  • ➡️ If so, continue...
  • If not, do one of the following:
    • 🚫 Respond with link to PR fixing the issue, ask them to upgrade & close
    • ❓🏷 + Awaiting Information, 🏷 - Needs Triage and respond with 📝 update npm
  1. ☑️ Ensure bug is reproducible on reported system/npm/node configuration:
  • ➡️ If so, continue...
  • If not, do one of the following:
    • ❓🏷 + Awaiting Information, 🏷 - Needs Triage and ask for clarifying information
    • 🚫 If not, respond with not reproducible & close
    • remove Needs Triage & Bug labels
    • add Question label
  1. ☑️ Write a failing test that reproduces bug & submit a PR (Optional)
  2. ☑️ Determine & label accordingly (no label is required for low-priority icebox/backlogged bugs)
  3. Move to next issue...

📝 Response Templates 📝

More Info

🚫 If not, respond and link to PR fix, ask them to upgrade & close

Support

If the issue is a question about how to do something with npm, direct them to github.community.

**Closing:** this looks to be a question about how to do something with `npm`. For support please post your question to [github.community](https://github.community).

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.

Update npm

<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.

Not a Bug RFC

<authors_username> Thanks for filing this! This is currently working as intended, and would be best suited as an 

I've transferred the issue to that repo for future discussion

<! -- OR -->

Can you create [an RFC](https://github.com/npm/rfcs/issues/new?assignees=&labels=&template=rrfc.md&title=%5BRRFC%5D+%3Ctitle%3E) in that repo?
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 RFC

<author_username> Thanks for taking the time to share your idea! New ideas are always appreciated and are better suited for [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.

I've transferred the issue to that repo for future discussion

<! -- OR -->

Can you create [an RFC](https://github.com/npm/rfcs/issues/new?assignees=&labels=&template=rrfc.md&title=%5BRRFC%5D+%3Ctitle%3E) in that repo?

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.

npm6

npm `v6` is no longer in active development; We will continue to push security releases to `v6` at our team's discretion as-per our [Support Policy](https://github.com/npm/cli/wiki/Support-Policy).

If your bug is preproducible on `v7`, please re-file this issue using our [new issue template](https://github.com/npm/cli/issues/new?assignees=&labels=Bug%2CNeeds+Triage%2CRelease+7.x&template=bug_7.yml&title=%5BBUG%5D+%3Ctitle%3E).

If your issue was a feature request, please consider opening a new [RRFC](https://github.com/npm/rfcs/issues) or [RFC](https://github.com/npm/rfcs). If your issue was a question or other idea that was not CLI-specific, consider opening a discussion on our [feedback repo](https://github.com/npm/feedback)

npm docs | npm | github.community

Clone this wiki locally