aws / aws/aws-encryption-sdk-javascript

Create FAQ for common errors on encrypt/decrypt

Đang mở
#305 3 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
TypeScript
Star
260
Fork
68
Merge trung bình
22 giờ 19 phút
Pull request đã merge (30 ngày)
2

Mô tả

Errors can bubble up from the encrypt/decrypt functions.
It would be nice to have clear explanations for common errors.

In creating this documentation,
the error messages can also be re-evaluated for clarity.

See #152 as an example.

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

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

Hướng nghiên cứu

Bắt đầu bằng việc xem xét issue #152 và lần theo các hàm encrypt/decrypt để xác định những lỗi phổ biến được hiển thị cho người dùng. Ghi lại các giải thích rõ ràng cho những lỗi đã chọn và ghi nhận mọi thông báo lỗi cần được đánh giá lại về mức độ rõ ràng; được xem là hoàn tất khi FAQ bao quát các trường hợp lỗi đã thống nhất và các thay đổi về cách diễn đạt đã được quyết định.

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

Đánh giá

Công nghệ
typescript
Lĩnh vực
documentation, security
Loại issue
Tài liệu
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/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.