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.