rt2zz/redux-persist

Better docs in README for persistConfig options

Offen

#948 geöffnet am 14.12.2018

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

Repository-Metriken

Stars
 (12.958 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

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

Research-Richtung
Untersuche die persistConfig Typdefinition in src/types.js und liste alle Optionen mit Beschreibungen auf. Füge einen neuen Abschnitt in README.md hinzu, der jede Option dokumentiert.
Tech Stack
typescript
Domain
frontend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80