Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
139 lines (92 loc) · 4.21 KB

CONTRIBUTING.md

File metadata and controls

139 lines (92 loc) · 4.21 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 pnpm workspaces. It contains the following packages:

  • The library package in the root directory.
  • An example app in the example/ directory.
  • A documentation site in the docs/ directory.

To get started with the project, make sure you have the correct version of Node.js installed. See the .nvmrc file for the version used in this project.

Run pnpm install in the root directory to install the required dependencies for each package:

pnpm install

Since the project relies on pnpm workspaces, you cannot use npm for development without manually migrating.

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.

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

To start the Expo example app:

pnpm dev:example

To run the example app on Android:

pnpm --filter native-library-example android

To run the example app on iOS:

pnpm --filter native-library-example ios

To run the example app on Web:

pnpm --filter native-library-example web

To start the documentation site:

pnpm dev:docs

Make sure your code passes TypeScript:

pnpm typecheck

To typecheck both the library and docs:

pnpm typecheck:all

To check for linting errors, run the following:

pnpm lint

To fix formatting errors, run the following:

pnpm format

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

pnpm 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.

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:

pnpm release

Scripts

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

  • pnpm install: setup project by installing dependencies.
  • pnpm dev:example: start the Expo example app.
  • pnpm dev:docs: start the documentation site.
  • pnpm build: build the library.
  • pnpm typecheck: type-check library files with TypeScript.
  • pnpm typecheck:all: type-check library and docs.
  • pnpm lint: lint files with ESLint.
  • pnpm format: format files with Prettier.
  • pnpm test: run unit tests with Jest.
  • pnpm release: publish a new release.

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.