Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
162 lines (112 loc) · 5.97 KB

CONTRIBUTING.md

File metadata and controls

162 lines (112 loc) · 5.97 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:

  • 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/BsDiffPatchExample.xcworkspace in XCode and find the source files at Pods > Development Pods > react-native-bs-diff-patch.

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

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

To start the packager:

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

Web implementation changes should also pass:

yarn test:web
yarn test:web:browser
yarn test:web:metro

Documentation and site changes should pass:

yarn site:build
yarn site:test
yarn site:test:browser

Public English guides live in docs/, with their Chinese mirrors in docs/zh-CN/. Keep both languages aligned when a change affects API behavior, platform support, errors, or operational guidance.

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 release-it to bump the version, create the tag, and publish the GitHub Release. Publishing that release starts .github/workflows/npm-publish.yml, which publishes to npm through OIDC Trusted Publishing and verifies the package provenance. No long-lived npm token is stored in GitHub.

Maintainers should run the quality gates, then create the release:

yarn prepare
yarn typecheck
yarn lint
yarn test --runInBand
yarn release

The npm package already trusts the JimmyDaddy/react-native-bs-diff-patch repository and the npm-publish.yml workflow. No npm-side configuration is required for a release. The release tag must exactly match v<package.json version>.

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 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 build:web: regenerate the checked-in WebAssembly bundle with Emscripten.
  • yarn test:web: verify the WebAssembly patch format and round trip.
  • yarn test:web:browser: exercise the public Web Worker API in Chrome.
  • yarn test:web:metro: verify Metro resolves the React Native Web entry.
  • yarn site:build: render public Markdown and static site assets into site-dist/.
  • yarn site:test: validate site structure and local links.
  • yarn site:test:browser: verify the live Playground, docs, and mobile viewport.

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.