Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Title: Inconsistency between yarn.lock file and npm installation instructions #117

Open
PaulChass opened this issue Aug 31, 2024 · 0 comments

Comments

@PaulChass
Copy link

Description

There is an inconsistency in the repository regarding the package manager used. The repository contains a yarn.lock file, which suggests that Yarn is being used for dependency management. However, the documentation instructs users to install dependencies using npm install.

Steps to Reproduce

  1. Clone the repository.
  2. Notice the presence of the yarn.lock file.
  3. Refer to the documentation which instructs to run npm install.

Expected Behavior

The repository should consistently use either npm or Yarn for dependency management. The documentation and lock files should reflect the chosen package manager.

Suggested Solution

  • Decide on a single package manager for the project.
  • If npm is chosen, remove the yarn.lock file and update the documentation accordingly.
  • If Yarn is chosen, remove the package-lock.json file (if it exists) and update the documentation to instruct users to run yarn install.

Additional Context

This inconsistency can lead to confusion and potential issues for contributors and users of the project. Standardizing on a single package manager will help maintain consistency and reliability.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant