From 481b66f6b4e89596f815b0a2a46b3bd92fceb911 Mon Sep 17 00:00:00 2001 From: Vojtech Novak Date: Thu, 18 Feb 2021 00:11:38 +0100 Subject: [PATCH 1/2] chore: update contrbuting docs --- CONTRIBUTING.md | 26 +++++++++++++------------- README.md | 9 ++++++--- 2 files changed, 19 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 903daf88..05199c0e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ Development can be done using the example app. Follow readme instructions on run ```sh git clone /~https://github.com/react-native-community/datetimepicker.git cd datetimepicker -npm install +yarn ``` ### Tests @@ -15,8 +15,8 @@ npm install #### Jest ```sh -npm install -npm run test +yarn +yarn test ``` #### Detox @@ -33,16 +33,16 @@ For cleaning all the detox builds just run `npm run detox:clean`. ```sh # Debug requires to run Metro Bundler - npm run start - npm run detox:ios:build:debug - npm run detox:ios:test:debug + yarn start + yarn detox:ios:build:debug + yarn detox:ios:test:debug ``` - release: ```sh - npm run detox:ios:build:release - npm run detox:ios:test:release + yarn detox:ios:build:release + yarn detox:ios:test:release ``` ##### Android @@ -53,14 +53,14 @@ An existing Android emulator is required to match the name defined in `detox.con ```sh # Debug requires to run Metro Bundler - npm run start - npm run detox:android:build:debug - npm run detox:android:test:debug + yarn start + yarn detox:android:build:debug + yarn detox:android:test:debug ``` - release: ```sh - npm run detox:android:build:release - npm run detox:android:test:release + yarn detox:android:build:release + yarn detox:android:test:release ``` diff --git a/README.md b/README.md index f030f165..55b38bf4 100644 --- a/README.md +++ b/README.md @@ -697,9 +697,12 @@ Add `PackageProviders().Append(winrt::DateTimePicker::ReactPackageProvider());` ## Running the example app -1. Install required pods in `example/ios` by running `npx pod-install` -1. Run `npm start` to start Metro Bundler -1. Run `npm run start:ios` or `npm run start:android` or `npm run start:windows` (or `yarn run start:windows`) +1. run `yarn` in repo root +2. run `cd example` +3. Install required pods by running `npx pod-install` +4. Run `yarn start` to start Metro Bundler +5. Run `yarn run start:ios` or `yarn run start:android` or `yarn run start:windows` +6. to do any development on the library, open the example project (in the example folder!) in xCode or Android Studio [circle-ci-badge]: https://img.shields.io/circleci/project/github/react-native-community/datetimepicker/master.svg?style=flat-square [circle-ci-status]: https://circleci.com/gh/react-native-datetimepicker/datetimepicker.svg?style=svg From 1ee2d494cdae118dae9c615ed5421adbf16ebf66 Mon Sep 17 00:00:00 2001 From: Vojtech Novak Date: Thu, 18 Feb 2021 00:13:58 +0100 Subject: [PATCH 2/2] chore: update contrbuting docs --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 55b38bf4..801ddaea 100644 --- a/README.md +++ b/README.md @@ -697,12 +697,12 @@ Add `PackageProviders().Append(winrt::DateTimePicker::ReactPackageProvider());` ## Running the example app -1. run `yarn` in repo root -2. run `cd example` +1. Run `yarn` in repo root +2. Run `cd example` 3. Install required pods by running `npx pod-install` 4. Run `yarn start` to start Metro Bundler 5. Run `yarn run start:ios` or `yarn run start:android` or `yarn run start:windows` -6. to do any development on the library, open the example project (in the example folder!) in xCode or Android Studio +6. To do any development on the library, open the example project (in the example folder!) in xCode or Android Studio. The example project depends on the library code, which you can edit and observe any changes in the example project. [circle-ci-badge]: https://img.shields.io/circleci/project/github/react-native-community/datetimepicker/master.svg?style=flat-square [circle-ci-status]: https://circleci.com/gh/react-native-datetimepicker/datetimepicker.svg?style=svg