rt2zz/redux-persist

Better docs in README for persistConfig options

Open

#948 geöffnet am 14. Dez. 2018

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (12.744 Stars) (879 Forks)batch import
docsgood first issue

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic knowledge of ReduxUnderstanding of persistConfig options
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75
Research-Richtung
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.