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

[DOC]: use pnpm add <pkg> instead of pnpm install <pkg> #2629

Merged
merged 3 commits into from
Sep 16, 2024

Conversation

jferrettiboke
Copy link
Contributor

It should be pnpm add <pkg> instead of pnpm install <pkg>.

pnpm install is used to install all dependencies for a project while pnpm add <pkg> is used to install a package and any packages that it depends on.

More info (official source):


pnpm install <pkg> does the same as pnpm add <pkg> today, but it might stop functioning that way in future versions since the official docs clarify the difference between the two. It might be that pnpm install <pkg> was used in past versions, and the PNPM team didn't want to remove support for it right away after introducing pnpm add <pkg>.

Copy link

github-actions bot commented Aug 3, 2024

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@jeffchuber jeffchuber self-assigned this Sep 16, 2024
@jeffchuber
Copy link
Contributor

@jferrettiboke weird github issue where the test suite didnt run (cant merge without it...). - can you bump a commit to this to retrigger them? (add whitespace to a README or something) id be happy to do it but im on an airplane and the wifi is terrible :)

@jferrettiboke
Copy link
Contributor Author

@jeffchuber I think you have to click on "Approve and run".

@tazarov
Copy link
Contributor

tazarov commented Sep 16, 2024

@jferrettiboke, the PR title check fails. Can you do me a favor and update the title to start with [DOC]: then make a tiny change in a new commit so that the PR check runs again.

@jferrettiboke jferrettiboke changed the title fix(docs): use pnpm add <pkg> instead of pnpm install <pkg> [DOC]: use pnpm add <pkg> instead of pnpm install <pkg> Sep 16, 2024
@jferrettiboke
Copy link
Contributor Author

@tazarov Done. ✅

@tazarov
Copy link
Contributor

tazarov commented Sep 16, 2024

@tazarov Done. ✅

Thanks @jferrettiboke, looks good in CI now

@tazarov tazarov merged commit b39fa4f into chroma-core:main Sep 16, 2024
10 checks passed
@jferrettiboke jferrettiboke deleted the patch-1 branch September 16, 2024 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants