You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+28-13Lines changed: 28 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,11 @@
1
1
# Contributing
2
-
We are open to, and grateful for, any contributions made by the community. By contributing to React Redux, you agree to abide by the [code of conduct](https://github.com/reduxjs/react-redux/blob/master/CODE_OF_CONDUCT.md).
2
+
3
+
We are open to, and grateful for, any contributions made by the community. By contributing to React Redux, you agree to abide by the [code of conduct](https://github.com/reduxjs/react-redux/blob/master/CODE_OF_CONDUCT.md).
3
4
4
5
Please review the [Redux Style Guide](https://redux.js.org/style-guide/style-guide) in the Redux docs to keep track of our best practices.
5
6
6
7
## Reporting Issues and Asking Questions
8
+
7
9
Before opening an issue, please search the [issue tracker](https://github.com/reduxjs/react-redux/issues) to make sure your issue hasn't already been reported.
8
10
9
11
Please ask any general and implementation specific questions on [Stack Overflow with a Redux tag](http://stackoverflow.com/questions/tagged/redux?sort=votes&pageSize=50) for support.
@@ -13,43 +15,56 @@ Please ask any general and implementation specific questions on [Stack Overflow
13
15
Visit the [Issue tracker](https://github.com/reduxjs/react-redux/issues) to find a list of open issues that need attention.
This repository uses Yarn v2 to manage packages. You'll need to have Yarn v1.22 installed globally on your system first, as Yarn v2 depends on that being available first. Install dependencies with:
24
+
25
+
```
26
+
yarn install
27
+
```
28
+
20
29
### Building
21
30
22
31
Running the `build` task will create both a CommonJS module-per-module build and a UMD build.
32
+
23
33
```
24
-
npm run build
34
+
yarn build
25
35
```
26
36
27
37
To create just a CommonJS module-per-module build:
38
+
28
39
```
29
-
npm run build:lib
40
+
yarn build:lib
30
41
```
31
42
32
43
To create just a UMD build:
44
+
33
45
```
34
-
npm run build:umd
35
-
npm run build:umd:min
46
+
yarn build:umd
47
+
yarn build:umd:min
36
48
```
37
49
38
50
### Testing and Linting
39
51
40
52
To run the tests:
53
+
41
54
```
42
-
npm run test
55
+
yarn test
43
56
```
44
57
45
58
To continuously watch and run tests, run the following:
59
+
46
60
```
47
-
npm test -- --watch
61
+
yarn test --watch
48
62
```
49
63
50
64
To perform linting with `eslint`, run the following:
65
+
51
66
```
52
-
npm run lint
67
+
yarn lint
53
68
```
54
69
55
70
### New Features
@@ -58,11 +73,11 @@ Please open an issue with a proposal for a new feature or refactoring before sta
58
73
59
74
## Submitting Changes
60
75
61
-
* Open a new issue in the [Issue tracker](https://github.com/reduxjs/react-redux/issues).
62
-
* Fork the repo.
63
-
* Create a new feature branch based off the `master` branch.
64
-
* Make sure all tests pass and there are no linting errors.
65
-
* Submit a pull request, referencing any issues it addresses.
76
+
- Open a new issue in the [Issue tracker](https://github.com/reduxjs/react-redux/issues).
77
+
- Fork the repo.
78
+
- Create a new feature branch based off the `master` branch.
79
+
- Make sure all tests pass and there are no linting errors.
80
+
- Submit a pull request, referencing any issues it addresses.
66
81
67
82
Please try to keep your pull request focused in scope and avoid including unrelated commits.
[](http://www.reactiflux.com)
10
9
11
-
12
10
## Installation
13
11
14
12
### Using Create React App
@@ -35,18 +33,17 @@ yarn add react-redux
35
33
36
34
You'll also need to [install Redux](https://redux.js.org/introduction/installation) and [set up a Redux store](https://redux.js.org/recipes/configuring-your-store/) in your app.
37
35
38
-
This assumes that you’re using [npm](http://npmjs.com/) package manager
39
-
with a module bundler like [Webpack](https://webpack.js.org/) or
40
-
[Browserify](http://browserify.org/) to consume [CommonJS
36
+
This assumes that you’re using [npm](http://npmjs.com/) package manager
37
+
with a module bundler like [Webpack](https://webpack.js.org/) or
38
+
[Browserify](http://browserify.org/) to consume [CommonJS
If you don’t yet use [npm](http://npmjs.com/) or a modern module bundler, and would rather prefer a single-file [UMD](https://github.com/umdjs/umd) build that makes `ReactRedux` available as a global object, you can grab a pre-built version from [cdnjs](https://cdnjs.com/libraries/react-redux). We *don’t* recommend this approach for any serious application, as most of the libraries complementary to Redux are only available on [npm](http://npmjs.com/).
41
+
If you don’t yet use [npm](http://npmjs.com/) or a modern module bundler, and would rather prefer a single-file [UMD](https://github.com/umdjs/umd) build that makes `ReactRedux` available as a global object, you can grab a pre-built version from [cdnjs](https://cdnjs.com/libraries/react-redux). We _don’t_ recommend this approach for any serious application, as most of the libraries complementary to Redux are only available on [npm](http://npmjs.com/).
44
42
45
43
## React Native
46
44
47
45
As of React Native 0.18, React Redux 5.x should work with React Native. If you have any issues with React Redux 5.x on React Native, run `npm ls react` and make sure you don’t have a duplicate React installation in your `node_modules`. We recommend that you use `[email protected]` which is better at avoiding these kinds of issues.
48
46
49
-
50
47
## Documentation
51
48
52
49
The React Redux docs are now published at **https://react-redux.js.org** .
@@ -55,9 +52,9 @@ We're currently expanding and rewriting our docs content - check back soon for m
55
52
56
53
## How Does It Work?
57
54
58
-
We do a deep dive on how React Redux works in [this readthesource episode](https://www.youtube.com/watch?v=VJ38wSFbM3A).
55
+
We do a deep dive on how React Redux works in [this readthesource episode](https://www.youtube.com/watch?v=VJ38wSFbM3A).
59
56
60
-
Also, the post [The History and Implementation of React-Redux](https://blog.isquaredsoftware.com/2018/11/react-redux-history-implementation/)
57
+
Also, the post [The History and Implementation of React-Redux](https://blog.isquaredsoftware.com/2018/11/react-redux-history-implementation/)
61
58
explains what it does, how it works, and how the API and implementation have evolved over time.
0 commit comments