-
-
Notifications
You must be signed in to change notification settings - Fork 927
Closed as not planned
Labels
good first issueNew-contributor friendlyNew-contributor friendlyhacktoberfeststale✨ goal: improvementImprovement to an existing featureImprovement to an existing feature📄 aspect: textConcerns the textual material in the repositoryConcerns the textual material in the repository
Description
what's wrong with the documentation?
Issue Description
-
The current README file still uses npm and yarn for package management. However, our project has standardized on pnpm, and continuing to mention npm or yarn may confuse new contributors.
-
We need to update the README to clearly instruct contributors to use pnpm for installing dependencies, running scripts, and contributing to the project.
-
Additionally, yarn should be removed from the main dependencies. If it’s required for specific development tasks, it should be listed under devDependencies instead. Keeping it in dependencies unnecessarily bloats the build and increases install time.
Expected Outcome
The README should provide clear, accurate, and consistent setup instructions using pnpm only, ensuring a smoother onboarding experience for new contributors.
Add screenshots
Record
- I have checked the existing issues
- I have read the Contributing Guidelines
- I agree to follow this project's Code of Conduct
- I want to work on this issue
- I am a Hacktoberfest contributor
Metadata
Metadata
Assignees
Labels
good first issueNew-contributor friendlyNew-contributor friendlyhacktoberfeststale✨ goal: improvementImprovement to an existing featureImprovement to an existing feature📄 aspect: textConcerns the textual material in the repositoryConcerns the textual material in the repository