nodejs / nodejs/node-gyp

Why is `package-lock.json` ignored?

Open
#3,060 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
10.7k
Forks
1.9k
Avg merge
1d 4h
Merged PRs (30d)
5

Description

This was first brought up in a review. A couple people mentioned this. No action was taken.

https://github.com/nodejs/node-gyp/pull/1573/files/020e2bdb6836b57462cccac6083a67f074019658#diff-bc37d034bad564583790a46f19d807abfe519c5671395fd494d8cce506c42947

Why is package-lock.json ignored? https://github.com/nodejs/node-gyp/blob/main/.gitignore#L7

The general consensus seems to bee that it should be committed. If there is a reason it shouldn't, it should probably be listed alongside the ignore (as a comment).

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.

Research direction

Start by inspecting .gitignore at line 7 and the linked node-gyp pull request review. Determine why package-lock.json is ignored and whether the repository's intended policy is documented elsewhere. Done means either documenting the reason beside the ignore rule or clarifying the repository change needed if no reason exists.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js
Domain
build-system, tooling
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.