Skip to content

Commit fbd29fb

Browse files
committed
Update to README.md - New maintainer
1 parent d7efde9 commit fbd29fb

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,49 @@
11
# Redux Persist
2-
32
Persist and rehydrate a redux store.
43

54
[![build status](https://img.shields.io/travis/rt2zz/redux-persist/master.svg?style=flat-square)](https://travis-ci.org/rt2zz/redux-persist) [![npm version](https://img.shields.io/npm/v/redux-persist.svg?style=flat-square)](https://www.npmjs.com/package/redux-persist) [![npm downloads](https://img.shields.io/npm/dm/redux-persist.svg?style=flat-square)](https://www.npmjs.com/package/redux-persist)
65
[![#redux-persist on Discord](https://img.shields.io/discord/102860784329052160.svg)](https://discord.gg/ExrEvmv)
76

7+
## September 22nd, 2021 - Under New Management
8+
9+
Redux Persist is a staple project for Redux developers, both on mobile and on the web. If you're here, it's likely because you need it now or have used it before and need to debug something, and like me have possibly struggled with making it work (especially with newer versions of things) and making it work with _your_ code because the examples you'll find around the internet are inconsistent.
10+
11+
I (@ckalika) spoke with @rt2zz about taking over maintenance of the project, and we agreed to give it a shot and see how we go. My priorities are as follows:
12+
13+
1. Go through and triage the existing issues
14+
- Separate them into bugs, feature requests, basic questions/requests for code samples, and issues that are either not project-specific or don't fall within the remit of the project (specific definitions and criteria will be posted in the future)
15+
- Determine the severity/urgency of each bug or feature request
16+
- Guestimate the size of them
17+
- Determine which are actionable immediately or in the short term
18+
- Establish some semblance of test criteria for each
19+
20+
21+
2. Upgrade dependencies (where possible) so that we've got something building with modern versions
22+
* Note: Right now, it's about modernising the project infrastructure and build process without making breaking API changes
23+
24+
25+
3. Go through the existing pull requests
26+
- Merge the ones that deal with documentation, code samples, etc.
27+
- Review and merge the ones that deal with open issues
28+
- Review and merge the ones that will require breaking changes and consult authors about `redux-persist@v7` (feature set and requirements to be defined)
29+
30+
31+
4. Update the documentation
32+
- Split it out for both web and mobile
33+
- Providing code samples and test coverage for how to use the library
34+
- Provide or link to working examples that integrate with additional libraries (e.g. [RTK Query](https://redux-toolkit.js.org/rtk-query/overview)).
35+
36+
37+
5. Improve testing and automation
38+
- Move to GitHub Actions
39+
- Move from Ava to Jest
40+
41+
There's a lot to do here, so I'll ask your patience and understanding as I work through it. If you have ideas for how to improve the library, the documentation, or the community, I'd love to hear them, and if you're submitting pull requests (or have submitted some previously), please reach out and help me understand what you're aiming to do with it.
42+
43+
I'll try to get some discussions up to pull together ideas, so we can properly work out what the next version is likely to look like (spoiler: I'm guessing it's going to be in TypeScript instead of Flow).
44+
45+
46+
847
## v6 upgrade
948
**Web**: no breaking changes
1049
**React Native**: Users must now explicitly pass their storage engine in. e.g.

0 commit comments

Comments
 (0)