Skip to content

Commit 4db942a

Browse files
committed
Add CONTRIBUTING.md
1 parent 34ee9f0 commit 4db942a

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

CONTRIBUTING.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
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/rackt/react-redux/blob/master/CODE_OF_CONDUCT.md).
3+
4+
## Reporting Issues and Asking Questions
5+
Before opening an issue, please search the [issue tracker](https://github.com/rackt/react-redux/issues) to make sure your issue hasn't already been reported.
6+
7+
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.
8+
9+
## Development
10+
11+
Visit the [Issue tracker](https://github.com/rackt/react-redux/issues) to find a list of open issues that need attention.
12+
13+
Fork, then clone the repo:
14+
```
15+
git clone https://github.com/your-username/react-redux.git
16+
```
17+
18+
### Building
19+
20+
Running the `build` task will create both a CommonJS module-per-module build and a UMD build.
21+
```
22+
npm run build
23+
```
24+
25+
To create just a CommonJS module-per-module build:
26+
```
27+
npm run build:lib
28+
```
29+
30+
To create just a UMD build:
31+
```
32+
npm run build:umd
33+
npm run build:umd:min
34+
```
35+
36+
### Testing and Linting
37+
38+
To run the tests:
39+
```
40+
npm run test
41+
```
42+
43+
To continuously watch and run tests, run the following:
44+
```
45+
npm run test:watch
46+
```
47+
48+
To perform linting with `eslint`, run the following:
49+
```
50+
npm run lint
51+
```
52+
53+
###New Features
54+
55+
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.
56+
57+
###Style
58+
59+
[rackt](https://github.com/rackt) is trying to keep a standard style across its various projects, which can be found over in [eslint-config-rackt](https://github.com/rackt/eslint-config-rackt). If you have a style change proposal, it should first be proposed there. If accepted, we will be happy to accept a PR to implement it here.
60+
61+
## Submitting Changes
62+
63+
* Open a new issue in the [Issue tracker](https://github.com/rackt/react-redux/issues).
64+
* Fork the repo.
65+
* Create a new feature branch based off the `master` branch.
66+
* Make sure all tests pass and there are no linting errors.
67+
* Submit a pull request, referencing any issues it addresses.
68+
69+
Please try to keep your pull request focused in scope and avoid including unrelated commits.
70+
71+
After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.
72+
73+
Thank you for contributing!

0 commit comments

Comments
 (0)