From 5039391dc50d27b671fc149cbecffe205b72e5c4 Mon Sep 17 00:00:00 2001 From: "satyajit.happy" Date: Mon, 8 Jul 2019 12:21:04 +0200 Subject: [PATCH] docs: update development workflow. closes #133 --- packages/stack/README.md | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/packages/stack/README.md b/packages/stack/README.md index 36a67489..18eed3dd 100644 --- a/packages/stack/README.md +++ b/packages/stack/README.md @@ -27,10 +27,30 @@ export default createStackNavigator({ ## Development workflow -- Clone this repository -- Run `yarn` in the root directory and in the `example` directory -- Run `yarn dev` in the root directory -- Run `yarn start` in the `example` directory +To setup the development environment, open a Terminal in the repo directory and run the following: + +```sh +yarn bootstrap +``` + +While developing, you can run the example app with [Expo](https://expo.io/) to test your changes: + +```sh +yarn example start +``` + +Make sure your code passes TypeScript and ESLint. Run the following to verify: + +```sh +yarn typescript +yarn lint +``` + +To fix formatting errors, run the following: + +```sh +yarn lint --fix +``` ## Docs