Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: update contrbuting docs #397

Merged
merged 2 commits into from
Feb 23, 2021
Merged

chore: update contrbuting docs #397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
481b66f
chore: update contrbuting docs
vonovak Feb 17, 2021
1ee2d49
chore: update contrbuting docs
vonovak Feb 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ 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

#### Jest

```sh
npm install
npm run test
yarn
yarn test
```

#### Detox
Expand All @@ -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
Expand All @@ -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
```
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. 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
Expand Down