Skip to content

Commit c8c963b

Browse files
committed
Update CONTRIBUTING to mention Yarn, and update build status badge
1 parent 684bb14 commit c8c963b

File tree

2 files changed

+36
-24
lines changed

2 files changed

+36
-24
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# 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).
34

45
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.
56

67
## Reporting Issues and Asking Questions
8+
79
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.
810

911
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
1315
Visit the [Issue tracker](https://github.com/reduxjs/react-redux/issues) to find a list of open issues that need attention.
1416

1517
Fork, then clone the repo:
18+
1619
```
1720
git clone https://github.com/your-username/react-redux.git
1821
```
1922

23+
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+
2029
### Building
2130

2231
Running the `build` task will create both a CommonJS module-per-module build and a UMD build.
32+
2333
```
24-
npm run build
34+
yarn build
2535
```
2636

2737
To create just a CommonJS module-per-module build:
38+
2839
```
29-
npm run build:lib
40+
yarn build:lib
3041
```
3142

3243
To create just a UMD build:
44+
3345
```
34-
npm run build:umd
35-
npm run build:umd:min
46+
yarn build:umd
47+
yarn build:umd:min
3648
```
3749

3850
### Testing and Linting
3951

4052
To run the tests:
53+
4154
```
42-
npm run test
55+
yarn test
4356
```
4457

4558
To continuously watch and run tests, run the following:
59+
4660
```
47-
npm test -- --watch
61+
yarn test --watch
4862
```
4963

5064
To perform linting with `eslint`, run the following:
65+
5166
```
52-
npm run lint
67+
yarn lint
5368
```
5469

5570
### New Features
@@ -58,11 +73,11 @@ Please open an issue with a proposal for a new feature or refactoring before sta
5873

5974
## Submitting Changes
6075

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.
6681

6782
Please try to keep your pull request focused in scope and avoid including unrelated commits.
6883

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
React Redux
2-
=========================
1+
# React Redux
32

43
Official React bindings for [Redux](https://github.com/reduxjs/redux).
54
Performant and flexible.
65

7-
[![build status](https://img.shields.io/travis/reduxjs/react-redux/master.svg?style=flat-square)](https://travis-ci.org/reduxjs/react-redux) [![npm version](https://img.shields.io/npm/v/react-redux.svg?style=flat-square)](https://www.npmjs.com/package/react-redux)
6+
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/reduxjs/react-redux/CI?style=flat-square) [![npm version](https://img.shields.io/npm/v/react-redux.svg?style=flat-square)](https://www.npmjs.com/package/react-redux)
87
[![npm downloads](https://img.shields.io/npm/dm/react-redux.svg?style=flat-square)](https://www.npmjs.com/package/react-redux)
98
[![redux channel on discord](https://img.shields.io/badge/[email protected]?style=flat-square)](http://www.reactiflux.com)
109

11-
1210
## Installation
1311

1412
### Using Create React App
@@ -35,18 +33,17 @@ yarn add react-redux
3533

3634
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.
3735

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
4139
modules](https://webpack.js.org/api/module-methods/#commonjs).
4240

43-
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/).
4442

4543
## React Native
4644

4745
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.
4846

49-
5047
## Documentation
5148

5249
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
5552

5653
## How Does It Work?
5754

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).
5956

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/)
6158
explains what it does, how it works, and how the API and implementation have evolved over time.
6259

6360
Enjoy!

0 commit comments

Comments
 (0)