good-first-issue
good-first-issue copied to clipboard
docs: Improve Local Setup Guide for New Contributors
The Problem
Currently, the README.md file makes a few assumptions that can be challenging for new contributors:
- It primarily recommends using
bun, but does not provide installation instructions or alternatives likenpmoryarn. This can be a blocker ifbunis not installed. - When setting up the project with
npmoryarn, the development server fails to start due to aRollupErrorfrom thenuxt-simple-sitemapmodule.
These issues increase the barrier for new contributors to get the project running locally.
Proposed Solution
I have made the following improvements to the README.md:
- Added clear instructions for using
npmandyarnas alternatives tobun. - Included a new "Troubleshooting" section that explains how to resolve the
RollupErrorby temporarily disabling thenuxt-simple-sitemapmodule innuxt.config.ts.
This will provide a smoother setup experience for future contributors. I will be submitting a Pull Request shortly to address this.
assign me this please
Hi @ManojAhire , thanks for your interest! I've already submitted a PR (#2420) to address this issue. Please feel free to review it and leave any feedback you might have!