Skip to content

Commit dcba695

Browse files
Add contributing section (#14)
I want to make sure that contributing is as easy as possible for everyone.
1 parent 28f0946 commit dcba695

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -467,6 +467,31 @@ Check out the [type definition tests](https://github.com/philipp-spiess/react-re
467467

468468
Updates the component‘s state and _then_ calls the side effect function.The side effect will be called with a reference to the react component (`this`) as the first argument.
469469

470+
## Contributing
471+
472+
Every help on this project is greatly appreciated. To get you started, here's a quick guide on how to make good and clean pull-requests:
473+
474+
1. Create a fork of this [repository](https://github.com/philipp-spiess/react-recomponent), so you can work on your own environment.
475+
2. Install development dependencies locally:
476+
477+
```bash
478+
git clone [email protected]:<your-github-name>/react-recomponent.git
479+
cd react-recomponent
480+
yarn install
481+
```
482+
483+
3. Make changes using your favorite editor.
484+
4. Make sure that all tests are passing and that the code is formatted correctly:
485+
486+
```bash
487+
yarn format
488+
yarn test
489+
yarn test:types:flow
490+
```
491+
492+
5. Commit your changes ([here](https://chris.beams.io/posts/git-commit/) is a wonderful guide on how to make amazing git commits).
493+
6. After a few seconds, a button to create a pull request should be visible inside the [Pull requests](https://github.com/philipp-spiess/react-recomponent/pulls) section.
494+
470495
## License
471496

472497
[MIT](https://github.com/philipp-spiess/react-recomponent/blob/master/README.md)

0 commit comments

Comments
 (0)