CONTRIBUTING.md

Contributing

Contributions are always welcome, no matter how large or small!

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.

To get started please complete the following steps:

1 Fork the library

1. Fork the community-pass-react-native-wrapper repository
2. Create your feature branch (git checkout -b my-new-feature)

2 Install dependencies

While it's possible to use npm, the tooling is built around yarn, so you'll have an easier time if you use yarn for development for the following reasons:

• yarn is faster because it installs dependency packages in parallel while npm installs them sequentially.
• yarn automatically runs security checks in the background and uses the built-in license checker to avoid downloading dangerous scripts.
• yarn prevents dependency issues (incompatibility).

1. Open your command line and navigate to the root folder of your project. See example below:

cd /path/community-pass-react-native-wrapper

2. Run the following command on your command line to install the library dependencies:

yarn

or

npm install

3. After you have completed step 3, please navigate to the root folder of the CompassRNSampleApp. See example below:

cd /path/community-pass-react-native-wrapper/CompassRNSampleApp

4. Run the following command on your command line to install the CompassRNSampleApp dependencies:

yarn

or

npm install

3 Add the Community Pass Kernel Library file to your Android Project

To help you connect to the Community Pass Kernel, our team created the Community Pass Kernel Library (.AAR file) that bridges the gap between your application and the Community Pass Kernel. This library will enable you to use the CPK service’s APIs while working on this library.

3.1 Pre-Requisites

• You will need to use the Android Studio
• Download the Commmunity Pass Kernel AAR library which can be accessed through CP Assets Request. We will show you how to add the AAR to your project.

NOTE: Please note that you will need to request access to the AAR through CP Assets Request. The approval may take 1-2 business days. Once you have access, proceed to download the AAR library for your development environment.

3.2 Adding the Community Pass Kernel Library File

The following are the steps required to set up your project with the Community Pass Client SDK:

Locate and Move the Community Pass Kernel Library File to your Android Studio Project

1. Locate the folder where you downloaded the AAR library to. The library will have a name similar to the following example: community-pass-library-v2.5.1.aar

2. Start your Android Studio and click on the open button at the top right corner.

3. Navigate to the location of the community-pass-react-native-wrapper folder and select the android folder at the root level of the project. Click open.

Please note that there are two android folders in the project.

- In the root level of the library files (Open this)
- Inside the example folder

4. The project will take some time to build. After the build process is completed, click on the Project Tab in the top left corner and then click on the Project dropdown to open community-pass-react-native-wrapper.

5. Navigate through community-pass-react-native-wrapper from the dropdown > app > libs

6. Copy your AAR file into the libs folder in your Android Studio as shown in the figure below:

Figure 1 Move the Community Pass Kernel Library file to your Android Studio project

7. On the Android Studio top toolbar, click on Build > Rebuid Project to synchronize the project with the Gradle files. The project will take some time to build.

You should now have completed the process of adding the Community Pass AAR Library into your Android Studio Project.

You are now ready to install the CPK onto your POI device and connect your Reliant Application to the Community Pass Kernel services.

4 Start Metro Bundler and Run the CompassRNSampleApp Example Application

1. Open your command line and navigate to the CompassRNSampleApp folder of your project. See example below:

cd /path/community-pass-react-native-wrapper/CompassRNSampleApp

2. To start the packager run the following command on your command line:

yarn start

or

npx react-native start

3. Open another command line and navigate to the CompassRNSampleApp folder of your project. See example below:

cd /path/community-pass-react-native-wrapper/CompassRNSampleApp

4. Run the following command to build, install and start the CompassRNSampleApp application on your POI device.:

yarn android

or

npx react-native run-android

While developing, you can run the CompassRNSampleApp to test your changes. Any changes you make in your library's JavaScript code will be reflected in the CompassRNSampleApp without a rebuild. If you change any native code, then you'll need to rebuild the CompassRNSampleAppp.

5. After you are done making changes, run the following command to

npm pack

5 Quality Expectations

Please ensure any contributions include unit tests. The project maintains a high level of test coverage for its functionality. Submissions are expected to maintain a similar level of coverage.

5.1 Run Type-Safety Checks, Code Tests and Lint

We use TypeScript for type checking, ESLint with Prettier for linting and formatting the code, and Jest for testing.

Our pre-commit hooks verify that the linter and tests pass when committing.

Before making git commit and git push actions, please pay attention to the following tips:

1. Make sure your code passes TypeScript and ESLint. Run the following to verify:

yarn typescript
yarn lint

or

npm run lint

2. To fix formatting errors, run the following:

yarn lint --fix

or

npm run lint --fix

3. Remember to add tests for your change if possible. Run the unit tests by:

yarn test

or

npm run test

5.2 Commit message convention

We follow the conventional commits specification for our commit messages:

• fix: bug fixes, e.g. fix crash due to deprecated method.
• feat: new features, e.g. add new method to the module.
• refactor: code refactor, e.g. migrate from class components to hooks.
• docs: changes into documentation, e.g. add usage example for the module..
• test: adding or updating tests, e.g. add integration tests using detox.
• chore: tooling changes, e.g. change CI config.

Our pre-commit hooks verify that your commit message matches this format when committing.

6 Publishing

Note that the production version of the library is hosted at CP Assets for easier versioning. Please do not use yarn release and npm run release commands with the library.

7 Scripts

The package.json file contains various scripts for common tasks:

• yarn typescript: type-check files with TypeScript.
• yarn lint: lint files with ESLint.
• yarn test: run unit tests with Jest.
• yarn example start: start the Metro server for the CompassRNSampleApp.
• yarn example android: run the CompassRNSampleApp on Android.

and

• npm run typescript: type-check files with TypeScript.
• npm run lint: lint files with ESLint.
• npm run test: run unit tests with Jest.
• npm react-native start: start the Metro server for the CompassRNSampleApp.
• npm react-native android: run the CompassRNSampleApp on Android.

8 Sending a pull request

Working on your first pull request? You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.

When you're sending a pull request:

• Prefer small pull requests focused on one change.
• Verify that linters and tests are passing.
• Review the documentation to make sure it looks good.
• Follow the pull request template when opening a pull request.
• For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.