Skip to content

Commit 293362d

Browse files
committed
A little more contributing effort
1 parent f7e67c1 commit 293362d

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

CONTRIBUTING.md

+19-16
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,28 @@ Before opening an issue, please search the [issue tracker](https://github.com/re
88

99
Please ask any general and implementation specific questions on [Stack Overflow with a Redux Toolkit tag](http://stackoverflow.com/questions/tagged/redux-toolkit?sort=votes&pageSize=50) for support.
1010

11-
## Development
11+
## New Features
1212

13-
Visit the [Issue tracker](https://github.com/reduxjs/redux-toolkit/issues) to find a list of open issues that need attention.
13+
Please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.
1414

15-
Fork, then clone the repo:
15+
## Getting started
1616

17-
```
18-
git clone https://github.com/your-username/redux-toolkit.git
19-
```
17+
Visit the [Issue tracker](https://github.com/reduxjs/redux-toolkit/issues) to find a list of open issues that need attention.
2018

21-
Then run `yarn` from the parent directory.
19+
### Fork the repository
2220

23-
### Building
21+
Please use the GitHub UI to [fork this repository](https://github.com/reduxjs/redux-toolkit) (_read more about [Forking a repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo)_). Redux Toolkit has forked builds enabled in the CI, so you will see the build status of your fork's branch.
2422

25-
Running the `build` task will create both a CommonJS module-per-module build and a UMD build.
23+
### Install
2624

27-
```
28-
npm run build
25+
```bash
26+
$ cd redux-toolkit
27+
$ yarn
2928
```
3029

31-
### Testing and Linting
30+
### Tests
3231

33-
To run the tests:
32+
You can run tests for all packages with:
3433

3534
```
3635
yarn test
@@ -42,11 +41,15 @@ To continuously watch and run tests, run the following:
4241
yarn test --watch
4342
```
4443

45-
### New Features
44+
### Build
4645

47-
Please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.
46+
You can build the packages with the following command:
47+
48+
```
49+
yarn build
50+
```
4851

49-
## Submitting Changes
52+
## Git workflow / Submitting Changes
5053

5154
- Open a new issue in the [Issue tracker](https://github.com/reduxjs/redux-toolkit/issues).
5255
- Fork the repo.

0 commit comments

Comments
 (0)