Skip to content

Commit 0c72325

Browse files
committed
Contributing markdown Refresh
1 parent d36a3a1 commit 0c72325

File tree

1 file changed

+32
-10
lines changed

1 file changed

+32
-10
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,55 @@ 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-
## New Features
11+
We ask you to do this because StackOverflow has a much better job at keeping popular questions visible. Unfortunately good answers get lost and outdated on GitHub.
1212

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.
13+
Some questions take a long time to get an answer. If your question gets closed or you don't get a reply on StackOverflow for longer than a few days, we encourage you to post an issue linking to your question. We will close your issue but this will give people watching the repo an opportunity to see your question and reply to it on StackOverflow if they know the answer.
14+
15+
Please be considerate when doing this as this is not the primary purpose of the issue tracker.
16+
17+
### Help Us Help You
18+
19+
On both websites, it is a good idea to structure your code and question in a way that is easy to read to entice people to answer it. For example, we encourage you to use syntax highlighting, indentation, and split text in paragraphs.
20+
21+
Please keep in mind that people spend their free time trying to help you. You can make it easier for them if you provide versions of the relevant libraries and a runnable small project reproducing your issue. You can put your code on [JSBin](https://jsbin.com) or, for bigger projects, on GitHub. Make sure all the necessary dependencies are declared in `package.json` so anyone can run `npm install && npm start` and reproduce your issue.
1422

1523
## Getting started
1624

1725
Visit the [Issue tracker](https://github.com/reduxjs/redux-toolkit/issues) to find a list of open issues that need attention.
1826

27+
### Bugs and Improvements
28+
29+
We use the [Issue tracker](https://github.com/reduxjs/redux-toolkit/issues) to keep track of bugs and improvements to redux-toolkit itself, its examples, and the documentation. We encourage you to open issues to discuss improvements, architecture, theory, internal implementation, etc. If a topic has been discussed before, we will ask you to join the previous discussion.
30+
31+
### New Features
32+
33+
Please open an [issue](https://github.com/reduxjs/redux-toolkit/issues) 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.
34+
1935
### Fork the repository
2036

2137
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.
2238

39+
Fork, then clone the repo:
40+
41+
```sh
42+
git clone https://github.com/your-username/redux-toolkit.git
43+
```
44+
2345
### Install
2446

2547
```bash
2648
$ cd redux-toolkit
2749
$ yarn
2850
```
2951

52+
### Build
53+
54+
You can build the packages with the following command:
55+
56+
```
57+
yarn build
58+
```
59+
3060
### Tests
3161

3262
You can run tests for all packages with:
@@ -41,14 +71,6 @@ To continuously watch and run tests, run the following:
4171
yarn test --watch
4272
```
4373

44-
### Build
45-
46-
You can build the packages with the following command:
47-
48-
```
49-
yarn build
50-
```
51-
5274
## Git workflow / Submitting Changes
5375

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

0 commit comments

Comments
 (0)