Improve Readme and doc

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
25/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
dart
領域
documentation

調査の方向性

リポジトリの README から始め、パラメーター名をメソッドシグネチャーおよびドキュメントと比較してから、issue #47 とリンクされている RxCommand および RxDart のブログシリーズを確認します。ドキュメントの範囲を明確にし、一貫した名前のセットを選択します。新規コントリビューター向けのガイダンスが現在の API を反映し、提案された wiki の資料が最新になっていれば完了です。

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

説明

I really appreciate this package but I find the documentation difficult for newcomers:

  • Various discrepancies in the name of the parameters between Readme, methods' signatures and Doc. For example these 3 names are used for the same parameter: canExecute, restriction, registration. I saw that this problem is mentioned in issue #47 Nullability support which cite another different name, constraint.
  • The Readme seems to be aimed at those who already have some familiarity with this architecture, which is understandable; in the blog https://www.burkharts.net/apps/blog there are articles suitable for newcomers, but they are not up-to-date (for example, reference is made to the Observable of RxDart, which from version 0.23 directly uses the Stream). Not that this is a problem, I just guess that's why these guides weren't promoted more in the Readme.

I am inexperienced and unfamiliar with git but am available to help update the documentation. Personally, the guide that got me aficionado of this package was the blog article https://www.burkharts.net/apps/blog/rxvms-foundations-rxcommand-and-getit/, together with the two articles of the same series preceding it (which is much more complete than "Making Flutter more Reactive" mentioned in the Readme). One idea could be to update this series of articles to the current RxCommand and RxDart Api and make it available in the wiki of this repo.

主要言語
Dart
スター
136
フォーク
22
PR マージ指標
30日以内にマージされた PR はありません

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

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

似ている issue

Dart の issue をもっと見る

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

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