You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-99Lines changed: 8 additions & 99 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,111 +4,20 @@ We want this community to be friendly and respectful to each other. Please follo
4
4
5
5
## Development workflow
6
6
7
-
To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
7
+
It's all mentins in [Read Me Instruction](README.md) file, and if you wish to run demo.
8
+
it contains `example` folder open it into your editor
8
9
9
10
```sh
10
-
yarn
11
-
```
12
-
13
-
> While it's possible to use [`npm`](https://github.com/npm/cli), the tooling is built around [`yarn`](https://classic.yarnpkg.com/), so you'll have an easier time if you use `yarn` for development.
14
-
15
-
While developing, you can run the [example app](/example/) to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app.
16
-
17
-
To start the packager:
18
-
19
-
```sh
20
-
yarn example start
21
-
```
22
-
23
-
To run the example app on Android:
24
-
25
-
```sh
26
-
yarn example android
27
-
```
28
-
29
-
To run the example app on iOS:
30
-
31
-
```sh
32
-
yarn example ios
33
-
```
34
-
35
-
Make sure your code passes TypeScript and ESLint. Run the following to verify:
36
-
37
-
```sh
38
-
yarn typescript
39
-
yarn lint
40
-
```
41
-
42
-
To fix formatting errors, run the following:
43
-
44
-
```sh
45
-
yarn lint --fix
46
-
```
11
+
npm install
47
12
48
-
Remember to add tests for your change if possible. Run the unit tests by:
13
+
cd ios && pod install &&cd ..
14
+
or
15
+
cd ios && arch -x86_64 pod install &&cd .. [For M1 Chip user]
49
16
50
-
```sh
51
-
yarn test
17
+
npx react-native run-android
18
+
npx react-native run-ios
52
19
```
53
20
54
-
To edit the Objective-C files, open `example/ios/GeocodingReversegrocodingExample.xcworkspace` in XCode and find the source files at `Pods > Development Pods > react-native-geocoding-reversegrocoding`.
55
-
56
-
To edit the Kotlin files, open `example/android` in Android studio and find the source files at `reactnativegeocodingreversegrocoding` under `Android`.
57
-
58
-
### Commit message convention
59
-
60
-
We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:
61
-
62
-
-`fix`: bug fixes, e.g. fix crash due to deprecated method.
63
-
-`feat`: new features, e.g. add new method to the module.
64
-
-`refactor`: code refactor, e.g. migrate from class components to hooks.
65
-
-`docs`: changes into documentation, e.g. add usage example for the module..
66
-
-`test`: adding or updating tests, e.g. add integration tests using detox.
67
-
-`chore`: tooling changes, e.g. change CI config.
68
-
69
-
Our pre-commit hooks verify that your commit message matches this format when committing.
We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint](https://eslint.org/) with [Prettier](https://prettier.io/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing.
76
-
77
-
Our pre-commit hooks verify that the linter and tests pass when committing.
78
-
79
-
### Publishing to npm
80
-
81
-
We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.
82
-
83
-
To publish new versions, run the following:
84
-
85
-
```sh
86
-
yarn release
87
-
```
88
-
89
-
### Scripts
90
-
91
-
The `package.json` file contains various scripts for common tasks:
92
-
93
-
-`yarn bootstrap`: setup project by installing all dependencies and pods.
94
-
-`yarn typescript`: type-check files with TypeScript.
95
-
-`yarn lint`: lint files with ESLint.
96
-
-`yarn test`: run unit tests with Jest.
97
-
-`yarn example start`: start the Metro server for the example app.
98
-
-`yarn example android`: run the example app on Android.
99
-
-`yarn example ios`: run the example app on iOS.
100
-
101
-
### Sending a pull request
102
-
103
-
> **Working on your first pull request?** You can learn how from this _free_ series: [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).
104
-
105
-
When you're sending a pull request:
106
-
107
-
- Prefer small pull requests focused on one change.
108
-
- Verify that linters and tests are passing.
109
-
- Review the documentation to make sure it looks good.
110
-
- Follow the pull request template when opening a pull request.
111
-
- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.
0 commit comments