rt2zz/redux-persist

Better docs in README for persistConfig options

Open

#948 建立於 2018年12月14日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)TypeScript (12,744 star) (879 fork)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
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.
Better docs in README for persistConfig options · rt2zz/redux-persist#948 | Good First Issue