Skip to content

Latest commit

 

History

History
97 lines (63 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

97 lines (63 loc) · 3.64 KB
Raw

Contributing

We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project.

Development workflow

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

bun i

While it's possible to use npm, yarn, or pnpm, the tooling is built around bun, so you'll have an easier time if you use bun for development.

While developing, you can run the example app 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.

To start the packager:

bun example

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

bun tsc
bun lint
bun format

To fix formatting errors, run the following:

bun lint:fix
bun format:fix

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

bun test

To edit the Objective-C files, open example/ios/QuickCryptoExample.xcworkspace in XCode and find the source files at Pods > Development Pods > react-native-quick-crypto.

To edit the Kotlin files, open example/android in Android studio and find the source files at margelo/quickcrypto under Android.

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.

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 CI verify that the linter and tests pass when creating a PR.

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:

bun release

Scripts

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

  • bun bootstrap: setup project by installing all dependencies and pods.
  • bun tsc: type-check files with TypeScript.
  • bun lint: lint files with ESLint.
  • bun test: run unit tests with Jest.
  • bun example: start the Metro server for the example app.

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.