chroma icon indicating copy to clipboard operation
chroma copied to clipboard

fix(docs): use `pnpm add <pkg>` instead of `pnpm install <pkg>`

Open jferrettiboke opened this issue 1 year ago • 1 comments

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):

  • https://pnpm.io/cli/add
  • https://pnpm.io/cli/install

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>.

jferrettiboke avatar Aug 03 '24 10:08 jferrettiboke

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)

github-actions[bot] avatar Aug 03 '24 10:08 github-actions[bot]

@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 :)

jeffchuber avatar Sep 16 '24 00:09 jeffchuber

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

jferrettiboke avatar Sep 16 '24 09:09 jferrettiboke

@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.

tazarov avatar Sep 16 '24 10:09 tazarov

@tazarov Done. ✅

jferrettiboke avatar Sep 16 '24 13:09 jferrettiboke

@tazarov Done. ✅

Thanks @jferrettiboke, looks good in CI now

tazarov avatar Sep 16 '24 13:09 tazarov