SocketDev / SocketDev/socket-cli

Possibly outdated FAQ or unclear README

Open
#999 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
TypeScript
Stars
317
Forks
65
Avg merge
1h 26m
Merged PRs (30d)
30

Description

Hiya! There is (at least from my socket-inexperienced perspective) an inconsistency from the safe npm FAQ and this project's README.

The FAQ (chapter "How is the wrapper implemented?") says safe npm only currently works with npm, whilst the README mentions wrapping pnpm and yarn with security features

Does the latter refer to non-install security features? Or is the FAQ behind on this documentarion?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the README's Core Commands section with the linked safe npm FAQ, focusing on the claims about npm, pnpm, and yarn. Confirm the intended scope with a maintainer, then update the relevant documentation so both sources agree and clearly describe the supported commands and security features.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.