aws / aws/aws-encryption-sdk-javascript
Create FAQ for common errors on encrypt/decrypt
オープン
- 主要言語
- TypeScript
- スター
- 260
- フォーク
- 68
- 平均マージ
- 22時間 19分
- マージ済み PR(30日)
- 2
説明
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.
コントリビューションガイド
調査の方向性
まず issue #152 を確認し、encrypt/decrypt 関数を追跡して、ユーザーに公開される共通エラーを特定します。選択したエラーについて明確な説明を文書化し、明確さの再評価が必要なエラーメッセージを記録します。完了とは、FAQ が合意されたエラーケースを網羅し、文言の変更が決定されていることを意味します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- documentation, security
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100