React Cheat Sheet
Contributing
Setup
react-cheat-sheet
is a pretty standard create-react-app app. If you're fimiliar with a CRA app, everything should make sense.
Clone, setup, and run the project
git clone https://github.com/chantastic/react-cheat-sheet.git
cd react-cheat-sheet
yarn
yarn start
Yarn scripts
Command | Description |
---|---|
start |
starts a webpacks sever at localhost:3000 |
test |
runs tests using Jest |
prettier |
reformats all code using prettier |
add-contribs |
adds a contributer to all-contributorsrc |
generate-contribs |
generates a list of contributors on the README |
Minor changes
Changing an example is easy.
Find the file with the error and click the Pencil button (Edit this file
).
Make your changes and commit in the browser.
Github will do the rest for you.
I'll get notified and the change will be fixed on the next deploy.
Major changes
- Fork
- Make Change
- Run
yarn add-contribs
add yourself as a contributer. - Run
yarn generate-contribs
to generate an updated README. - PR back into
chantastic:master
Contributors
Thanks goes to these wonderful people (emoji key):
Michael Chan |
Jon Stuebe |
Ted Pennings |
James Miller |
Eugene Zhlobo |
Dan Abramov |
Alexander Burtsev |
Shrayas Rajagopal |
Christopher Miller |
This project follows the all-contributors specification. Contributions of any kind welcome!