SocketDev / SocketDev/socket-cli

Possibly outdated FAQ or unclear README

Offen
#999 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

documentation
Vorherrschende Sprache
TypeScript
Sterne
317
Forks
65
Ø Merge
1 Std. 26 Min.
Gemergte PRs (30 T.)
30

Beschreibung

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?

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Vergleiche den Abschnitt „Core Commands“ der README mit der verknüpften safe npm FAQ und konzentriere dich dabei auf die Aussagen zu npm, pnpm und yarn. Kläre den vorgesehenen Umfang mit einem Maintainer und aktualisiere anschließend die relevante Dokumentation, sodass beide Quellen übereinstimmen und die unterstützten Befehle sowie die Sicherheitsfunktionen klar beschreiben.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Ruhig
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.