[xstate store] Explain StoreSnapshot properties

オープン
#458 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
48/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
領域
documentation

調査の方向性

まず、StoreSnapshot のドキュメントとその JSDoc を見つけ、既存の context の説明を参考にしてください。error、output、status の用途をドキュメント化し、新しく参加する人が追加のコンテキストなしでこれらのプロパティを理解できるようになった時点で、ドキュメントと JSDoc の両方が完全になったとみなしてください。

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

説明

The docs explain what context is but I can't figure out just from reading the docs what error, output and status are supposed to be for. There is also no JSDoc explaining them. I'm not familiar yet with xstate and have been looking into xstate store as a "gateway drug". So that might explain why I'm not familiar with this concept yet.

主要言語
MDX
スター
39
フォーク
94
平均マージ
1日 2時間
マージ済み PR(30日)
13

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

statelyai/docs のほかの issue

statelyai/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

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

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