rt2zz/redux-persist

Better docs in README for persistConfig options

Open

#948 opened on Dec 14, 2018

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

Description

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.

Contributor guide

Tech stack
typescriptjavascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of ReduxUnderstanding of persistConfig options
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
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.