rt2zz/redux-persist

Better docs in README for persistConfig options

Open

#948 opened on 2018年12月14日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)TypeScript (12,744 stars) (879 forks)batch import
docsgood first issue

説明

There are a lot of options in persistConfig that aren't mentioned in the README. We should add a section to the README that documents each option you can declare in a persistConfig.

コントリビューターガイド

技術スタック
typescriptjavascript
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Basic knowledge of ReduxUnderstanding of persistConfig options
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75
調査方針
The issue requests adding a section to the README documenting each option in persistConfig. The source file is at src/types.js (line 13). Examine each exported constant or type in that file and write concise explanations for each option. The existing README serves as a template for style and format. No external dependencies or blockers noted.