0xMiden / 0xMiden/web-sdk

Errors: Error codes and errors guide

オープン
#93 コメント 2 件 リアクション 0 件 担当者 1 名 @WiktorStarczewski が担当を希望しています GitHub で見る
documentation
主要言語
TypeScript
スター
1
フォーク
21
平均マージ
12時間 14分
マージ済み PR(30日)
41

説明

### What should be done?

Let's introduce error codes to all errors, and publish an error guide, which documents possible common scenarios where a particular error can occur.

### How should it be done?

See "What".
Additional task, create a process for maintaining this error guide (DevRel?), and what support can the Engineering give (ie, if a new error is introduced, it should be documented what can be causing it).

### When is this task done?

When all errors have error codes and a errors guide exists to reference them and help debug.

### Additional context

_No response_

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

First, locate all error definitions in the codebase, likely in error-handling modules or classes. Assign unique error codes to each. Then, create an errors guide document that lists each code, describes common scenarios, and outlines a maintenance process for future errors. Check if there are existing error tests to understand the error structure.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
developer-experience, documentation
issue の種類
ドキュメント
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。