Create CONTRIBUTING.md

victordidenko · Sep 28, 2017 · 54cd447 · 54cd447
1 parent 2ba2556
commit 54cd447
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,10 @@
+# Contributing to Formik
+
+1. Fork this repository to your own GitHub account and then clone it to your local device.
+2. Install the dependencies: `yarn install`
+3. Run `yarn link` to link the local repo to NPM
+4. Run `yarn start` to build and watch for code changes
+5. Run `yarn test` to start Jest
+7. Then npm link this repo inside any other project on your local dev with `yarn link formik`
+8. Then you can use your local version of Formik within your project
+