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

docs: add fallback npm install:ci instructions to README #1325

Merged
merged 1 commit into from
Mar 3, 2025

Conversation

KJ7LNW
Copy link

@KJ7LNW KJ7LNW commented Mar 3, 2025

Context

Added fallback installation instructions to the README.md to address dependency issues when setting up the project locally. The npm run install:all command fails for first-time setup because it requires the npm-run-all package to be installed first.

Implementation

Updated the README.md file in the "Local Setup & Development" section to include a fallback instruction that directs users to run npm run install:ci if the initial npm run install:all command fails.

This approach provides a better developer experience by:

  1. Maintaining the simpler npm run install:all as the primary instruction for most users
  2. Providing a clear fallback option when the primary command fails
  3. Avoiding confusion for new contributors who might encounter the dependency error

The install:ci script first installs the npm-run-all package before running the install:all script, which resolves the dependency issue without requiring changes to the core build scripts.

How to Test

  1. Clone a fresh copy of the repository
  2. Try running npm run install:all - you should see an error about npm-run-all not being found
  3. Then run npm run install:ci - this should successfully install all dependencies
  4. Verify that the installation completes without errors

Get in Touch

Discord: @KJ7LNW


Important

Adds fallback npm install instructions to README.md for dependency issues during local setup.

  • Documentation:
    • Updated README.md in "Local Setup & Development" section.
    • Added fallback instruction to use npm run install:ci if npm run install:all fails due to missing npm-run-all package.

This description was created by Ellipsis for 5ee9b32. It will automatically update as commits are pushed.

@KJ7LNW KJ7LNW requested review from mrubens and cte as code owners March 3, 2025 00:06
Copy link

changeset-bot bot commented Mar 3, 2025

⚠️ No Changeset found

Latest commit: 475b6e2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. documentation Improvements or additions to documentation labels Mar 3, 2025
README.md Outdated
@@ -119,6 +119,12 @@ Make Roo Code work your way with:
```bash
npm run install:all
```

if that fails, try:
`bash
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please wrap the fallback installation command in a proper triple-backtick code block for consistency and readability. For example:

npm run install:ci

@KJ7LNW KJ7LNW force-pushed the roo-update-readme branch from 5ee9b32 to 7956377 Compare March 3, 2025 00:08
Add instructions to use 'npm run install:ci' as a fallback option if 'npm run install:all' fails. This addresses the dependency issue where npm-run-all needs to be installed before running the install:all script, providing clearer guidance for developers setting up the project locally.

Signed-off-by: Eric Wheeler <[email protected]>
@KJ7LNW KJ7LNW force-pushed the roo-update-readme branch from 7956377 to 475b6e2 Compare March 3, 2025 00:09
Copy link
Collaborator

@cte cte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yikes - thanks for updating. I need to clean this up a bit to provide a better first experience for potential contributors.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Mar 3, 2025
@cte cte merged commit a253a37 into RooVetGit:main Mar 3, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants