Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
executable file
·
146 lines (91 loc) · 4.81 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
146 lines (91 loc) · 4.81 KB
Raw

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.

Development workflow

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

  • Open example/ directory:

Initial Setup

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.

Running the Example

The standard React Native example app demonstrates usage of the library on mobile devices.

Setup (first time only):

yarn setup

This command installs dependencies, builds the library, and installs iOS pods.

Run the app:

To start the Metro bundler:

cd example && yarn start

To run on Android:

cd example && yarn android

To run on iOS:

cd example && yarn ios

Native Development

The example apps are 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 apps. Changes to the library's JavaScript code will be reflected 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:

  • Open example/android in Android Studio, or example/ios/BlurViewExample.xcworkspace in XCode.

To edit the Objective-C or Swift files in XCode, find the source files at Pods > Development Pods > react-native-blur-view.

To edit the Java or Kotlin files in Android Studio, find the source files at react-native-blur-view under Android.

To confirm that the app is running with the new architecture, you can check the Metro logs for a message like this:

Running "BlurViewExample" with {"fabric":true,"initialProps":{"concurrentRoot":true},"rootTag":1}

Note the "fabric":true and "concurrentRoot":true properties.

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

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.

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 semantic-release 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: setup project by installing dependencies.
  • yarn typecheck: type-check files with TypeScript.
  • yarn lint: lint files with ESLint.
  • yarn test: run unit tests with Jest.
  • yarn setup: setup of the example (install deps, build library, install pods).
  • yarn example: execute workspace 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.