Skip to content

Latest commit

 

History

History
110 lines (71 loc) · 3.94 KB

CONTRIBUTING.md

File metadata and controls

110 lines (71 loc) · 3.94 KB

Contributing

Contributions are always welcome!

Development workflow

This project is a monorepo managed using Yarn workspaces. It contains the following packages:

  • The library package in the root directory.
  • An example app in the example/ directory.

To get started with the project, run yarn in the root directory to install the required dependencies for each package:

yarn

Since the project relies on Yarn workspaces, you cannot use npm for development.

The example app demonstrates usage of the library. You need to run it to test any changes you make.

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.

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/EudiWalletKitReactNativeExample.xcworkspace in XCode and find the source files at Pods > Development Pods > eudi-wallet-kit-react-native.

To edit the Java or Kotlin files, open example/android in Android studio and find the source files at eudi-wallet-kit-react-native under Android.

You can use various commands from the root directory to work with the project.

To start Metro bundler:

yarn example:start

To run the example app on Android:

yarn example:android

To run the example app on iOS:

yarn example:ios

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

yarn typecheck
yarn lint

To fix formatting errors, run the following:

yarn lint --fix

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

yarn test

Linting and tests

ESLint, Prettier, TypeScript

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.

Publishing to npm

We use 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.

To publish new versions, run the following:

yarn release

Scripts

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

  • yarn install: setup project by installing dependencies.
  • yarn example:start: start the Metro server for the example app.
  • yarn example:android: run the example app on Android.
  • yarn example:ios: run the example app on iOS.
  • yarn test: run unit tests with Jest.
  • yarn typecheck: type-check files with TypeScript.
  • yarn lint: lint files with ESLint.
  • yarn prepare: build wrapper library.
  • yarn clean: remove artifacts from last library build.
  • yarn release: release a new version.

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 still relevant and looks good after your change.
  • 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.