SocketDev / SocketDev/socket-cli

Possibly outdated FAQ or unclear README

Đang mở
#999 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

documentation
Ngôn ngữ chính
TypeScript
Star
317
Fork
65
Merge trung bình
1 giờ 26 phút
Pull request đã merge (30 ngày)
30

Mô tả

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?

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

So sánh phần «Core Commands» trong README với safe npm FAQ được liên kết, tập trung vào các khẳng định về npm, pnpm và yarn. Xác nhận phạm vi dự kiến với một maintainer, sau đó cập nhật tài liệu liên quan để cả hai nguồn thống nhất với nhau và mô tả rõ các lệnh được hỗ trợ cũng như các tính năng bảo mật.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.