From 54cd447d874ab487aebf1749207dc652fbca56af Mon Sep 17 00:00:00 2001 From: Jared Palmer Date: Thu, 28 Sep 2017 10:54:26 -0400 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..b9557e8ea --- /dev/null +++ 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 +