Skip to content

Commit f374236

Browse files
alpesh12bhavin9488
alpesh12
authored and
bhavin9488
committed
Merge pull request #3 from logisticinfotech/ns-lib-version-upgrade
commit library version upgrade
2 parents bba71aa + 84d6f99 commit f374236

File tree

87 files changed

+17051
-49317
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+17051
-49317
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, caste, color, religion, or sexual
11+
identity and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the overall
27+
community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or advances of
32+
any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email address,
36+
without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official e-mail address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[INSERT CONTACT METHOD].
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series of
87+
actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or permanent
94+
ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within the
114+
community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.1, available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127+
[https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md

Lines changed: 76 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,105 +1,122 @@
11
# Contributing
22

3-
We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project.
3+
Contributions are always welcome, no matter how large or small!
4+
5+
We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the [code of conduct](./CODE_OF_CONDUCT.md).
46

57
## Development workflow
68

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
9+
This project is a monorepo managed using [Yarn workspaces](https://yarnpkg.com/features/workspaces). It contains the following packages:
910

10-
```sh
11-
npm install
11+
- The library package in the root directory.
12+
- An example app in the `example/` directory.
1213

13-
cd ios && pod install && cd ..
14-
or
15-
cd ios && arch -x86_64 pod install && cd .. [For M1 Chip user]
14+
To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
1615

17-
npx react-native run-android
18-
npx react-native run-ios
16+
```sh
17+
yarn
1918
```
2019

20+
> Since the project relies on Yarn workspaces, you cannot use [`npm`](https://github.com/npm/cli) for development.
2121
22-
## Code of Conduct
22+
The [example app](/example/) demonstrates usage of the library. You need to run it to test any changes you make.
2323

24-
### Our Pledge
24+
It is configured to use the local version of the library, so any changes you make to the library's source code will be reflected in the example app. Changes to the library's JavaScript code will be reflected in the example app without a rebuild, but native code changes will require a rebuild of the example app.
2525

26-
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
26+
If you want to use Android Studio or XCode to edit the native code, you can open the `example/android` or `example/ios` directories respectively in those editors. To edit the Objective-C or Swift files, open `example/ios/GeocodingReversegeocodingExample.xcworkspace` in XCode and find the source files at `Pods > Development Pods > react-native-geocoding-reversegeocoding`.
2727

28-
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
28+
To edit the Java or Kotlin files, open `example/android` in Android studio and find the source files at `react-native-geocoding-reversegeocoding` under `Android`.
2929

30-
### Our Standards
30+
You can use various commands from the root directory to work with the project.
3131

32-
Examples of behavior that contributes to a positive environment for our community include:
32+
To start the packager:
3333

34-
- Demonstrating empathy and kindness toward other people
35-
- Being respectful of differing opinions, viewpoints, and experiences
36-
- Giving and gracefully accepting constructive feedback
37-
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
38-
- Focusing on what is best not just for us as individuals, but for the overall community
34+
```sh
35+
yarn example start
36+
```
3937

40-
Examples of unacceptable behavior include:
38+
To run the example app on Android:
4139

42-
- The use of sexualized language or imagery, and sexual attention or
43-
advances of any kind
44-
- Trolling, insulting or derogatory comments, and personal or political attacks
45-
- Public or private harassment
46-
- Publishing others' private information, such as a physical or email
47-
address, without their explicit permission
48-
- Other conduct which could reasonably be considered inappropriate in a
49-
professional setting
40+
```sh
41+
yarn example android
42+
```
5043

51-
### Enforcement Responsibilities
44+
To run the example app on iOS:
5245

53-
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
46+
```sh
47+
yarn example ios
48+
```
5449

55-
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
50+
Make sure your code passes TypeScript and ESLint. Run the following to verify:
5651

57-
### Scope
52+
```sh
53+
yarn typecheck
54+
yarn lint
55+
```
5856

59-
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
57+
To fix formatting errors, run the following:
6058

61-
### Enforcement
59+
```sh
60+
yarn lint --fix
61+
```
6262

63-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
63+
Remember to add tests for your change if possible. Run the unit tests by:
6464

65-
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
65+
```sh
66+
yarn test
67+
```
6668

67-
### Enforcement Guidelines
69+
### Commit message convention
6870

69-
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
71+
We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:
7072

71-
#### 1. Correction
73+
- `fix`: bug fixes, e.g. fix crash due to deprecated method.
74+
- `feat`: new features, e.g. add new method to the module.
75+
- `refactor`: code refactor, e.g. migrate from class components to hooks.
76+
- `docs`: changes into documentation, e.g. add usage example for the module..
77+
- `test`: adding or updating tests, e.g. add integration tests using detox.
78+
- `chore`: tooling changes, e.g. change CI config.
7279

73-
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
80+
Our pre-commit hooks verify that your commit message matches this format when committing.
7481

75-
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
82+
### Linting and tests
7683

77-
#### 2. Warning
84+
[ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/)
7885

79-
**Community Impact**: A violation through a single incident or series of actions.
86+
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.
8087

81-
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
88+
Our pre-commit hooks verify that the linter and tests pass when committing.
8289

83-
#### 3. Temporary Ban
90+
### Publishing to npm
8491

85-
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
92+
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.
8693

87-
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
94+
To publish new versions, run the following:
8895

89-
#### 4. Permanent Ban
96+
```sh
97+
yarn release
98+
```
9099

91-
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
100+
### Scripts
92101

93-
**Consequence**: A permanent ban from any sort of public interaction within the community.
102+
The `package.json` file contains various scripts for common tasks:
94103

95-
### Attribution
104+
- `yarn`: setup project by installing dependencies.
105+
- `yarn typecheck`: type-check files with TypeScript.
106+
- `yarn lint`: lint files with ESLint.
107+
- `yarn test`: run unit tests with Jest.
108+
- `yarn example start`: start the Metro server for the example app.
109+
- `yarn example android`: run the example app on Android.
110+
- `yarn example ios`: run the example app on iOS.
96111

97-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
98-
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
112+
### Sending a pull request
99113

100-
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
114+
> **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).
101115
102-
[homepage]: https://www.contributor-covenant.org
116+
When you're sending a pull request:
103117

104-
For answers to common questions about this code of conduct, see the FAQ at
105-
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
118+
- Prefer small pull requests focused on one change.
119+
- Verify that linters and tests are passing.
120+
- Review the documentation to make sure it looks good.
121+
- Follow the pull request template when opening a pull request.
122+
- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.

‎LICENSE

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2021 Dhaval Mehta
4-
3+
Copyright (c) 2024 Naishadh Sakariya
54
Permission is hereby granted, free of charge, to any person obtaining a copy
65
of this software and associated documentation files (the "Software"), to deal
76
in the Software without restriction, including without limitation the rights

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# react-native-geocoding-reversegrocoding
1+
# react-native-geocoding-reversegeocoding
22

33
* No need to use Native modules anymore.
44
* No need to generate Google API key for geocoding functionality in react-native anymore.
@@ -11,7 +11,7 @@
1111
## Installation
1212

1313
```sh
14-
npm install @logisticinfotech/react-native-geocoding-reversegrocoding
14+
npm install @logisticinfotech/react-native-geocoding-reversegeocoding
1515
```
1616

1717
### Android
@@ -77,7 +77,7 @@ cd ..
7777
import {
7878
getLocationFromAddress,
7979
getAddressFromLocation
80-
} from "react-native-geocoding-reversegrocoding";
80+
} from "react-native-geocoding-reversegeocoding";
8181

8282
// ...
8383
// ...

0 commit comments

Comments
 (0)