Skip to content

Latest commit

 

History

History
95 lines (63 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

95 lines (63 loc) · 3.27 KB

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.
  • The mobile android app is in the example/ directory.
  • The Wear OS android app is in the watch-example/ directory.

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

yarn

Pair the Android and WearOS emulators

Build the Mobile App

The first step is building the react-native Android mobile app.

cd example
yarn install
yarn start
# Now build android
yarn android

Build the WearOS App

cd watch-example
yarn install
yarn start --port=8082

Build the project with yarn android, open the react native dev menu and change the bundle location to your-ip:8082 (for ex. 192.168.18.2:8082). Now you can build the WearOS app with the command:

yarn android

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.

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